Skip to content

Commit 4e50c73

Browse files
gcf-owl-bot[bot]amanda-tarafa
authored andcommitted
docs: clarify options for logs
docs: Clarify the custom instance template needs to be in the same project PiperOrigin-RevId: 702966613 Source-Link: googleapis/googleapis@2cb4e7a Source-Link: googleapis/googleapis-gen@14a9205 Copy-Tag: eyJwIjoiYXBpcy9Hb29nbGUuQ2xvdWQuQmF0Y2guVjFBbHBoYS8uT3dsQm90LnlhbWwiLCJoIjoiMTRhOTIwNTIwMWI4MDAwYTJmZWRkYTg5NGUxMDUyNTZjZWVkOTA3NSJ9
1 parent d336935 commit 4e50c73

File tree

1 file changed

+22
-13
lines changed
  • apis/Google.Cloud.Batch.V1Alpha/Google.Cloud.Batch.V1Alpha

1 file changed

+22
-13
lines changed

apis/Google.Cloud.Batch.V1Alpha/Google.Cloud.Batch.V1Alpha/Job.g.cs

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -974,8 +974,10 @@ public enum SchedulingPolicy {
974974
}
975975

976976
/// <summary>
977-
/// LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be
978-
/// preserved.
977+
/// LogsPolicy describes if and how a job's logs are preserved. Logs include
978+
/// information that is automatically written by the Batch service agent and any
979+
/// information that you configured the job's runnables to write to the `stdout`
980+
/// or `stderr` streams.
979981
/// </summary>
980982
[global::System.Diagnostics.DebuggerDisplayAttribute("{ToString(),nq}")]
981983
public sealed partial class LogsPolicy : pb::IMessage<LogsPolicy>
@@ -1028,7 +1030,7 @@ public LogsPolicy Clone() {
10281030
public const int DestinationFieldNumber = 1;
10291031
private global::Google.Cloud.Batch.V1Alpha.LogsPolicy.Types.Destination destination_ = global::Google.Cloud.Batch.V1Alpha.LogsPolicy.Types.Destination.Unspecified;
10301032
/// <summary>
1031-
/// Where logs should be saved.
1033+
/// If and where logs should be saved.
10321034
/// </summary>
10331035
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
10341036
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
@@ -1043,9 +1045,14 @@ public LogsPolicy Clone() {
10431045
public const int LogsPathFieldNumber = 2;
10441046
private string logsPath_ = "";
10451047
/// <summary>
1046-
/// The path to which logs are saved when the destination = PATH. This can be a
1047-
/// local file path on the VM, or under the mount point of a Persistent Disk or
1048-
/// Filestore, or a Cloud Storage path.
1048+
/// When `destination` is set to `PATH`, you must set this field to the path
1049+
/// where you want logs to be saved. This path can point to a local directory
1050+
/// on the VM or (if congifured) a directory under the mount path of any
1051+
/// Cloud Storage bucket, network file system (NFS), or writable persistent
1052+
/// disk that is mounted to the job. For example, if the job has a bucket with
1053+
/// `mountPath` set to `/mnt/disks/my-bucket`, you can write logs to the
1054+
/// root directory of the `remotePath` of that bucket by setting this field to
1055+
/// `/mnt/disks/my-bucket/`.
10491056
/// </summary>
10501057
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
10511058
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
@@ -1060,8 +1067,8 @@ public string LogsPath {
10601067
public const int CloudLoggingOptionFieldNumber = 3;
10611068
private global::Google.Cloud.Batch.V1Alpha.LogsPolicy.Types.CloudLoggingOption cloudLoggingOption_;
10621069
/// <summary>
1063-
/// Optional. Additional settings for Cloud Logging. It will only take effect
1064-
/// when the destination of `LogsPolicy` is set to `CLOUD_LOGGING`.
1070+
/// Optional. When `destination` is set to `CLOUD_LOGGING`, you can optionally
1071+
/// set this field to configure additional settings for Cloud Logging.
10651072
/// </summary>
10661073
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
10671074
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
@@ -1270,15 +1277,16 @@ public static partial class Types {
12701277
/// </summary>
12711278
public enum Destination {
12721279
/// <summary>
1273-
/// Logs are not preserved.
1280+
/// (Default) Logs are not preserved.
12741281
/// </summary>
12751282
[pbr::OriginalName("DESTINATION_UNSPECIFIED")] Unspecified = 0,
12761283
/// <summary>
1277-
/// Logs are streamed to Cloud Logging.
1284+
/// Logs are streamed to Cloud Logging. Optionally, you can configure
1285+
/// additional settings in the `cloudLoggingOption` field.
12781286
/// </summary>
12791287
[pbr::OriginalName("CLOUD_LOGGING")] CloudLogging = 1,
12801288
/// <summary>
1281-
/// Logs are saved to a file path.
1289+
/// Logs are saved to the file path specified in the `logsPath` field.
12821290
/// </summary>
12831291
[pbr::OriginalName("PATH")] Path = 2,
12841292
}
@@ -1336,7 +1344,7 @@ public CloudLoggingOption Clone() {
13361344
public const int UseGenericTaskMonitoredResourceFieldNumber = 1;
13371345
private bool useGenericTaskMonitoredResource_;
13381346
/// <summary>
1339-
/// Optional. Set this flag to true to change the [monitored resource
1347+
/// Optional. Set this field to `true` to change the [monitored resource
13401348
/// type](https://cloud.google.com/monitoring/api/resources) for
13411349
/// Cloud Logging logs generated by this Batch job from
13421350
/// the
@@ -5973,7 +5981,8 @@ public InstancePolicyOrTemplate Clone() {
59735981
/// Named the field as 'instance_template' instead of 'template' to avoid
59745982
/// C++ keyword conflict.
59755983
///
5976-
/// Batch only supports global instance templates.
5984+
/// Batch only supports global instance templates from the same project as
5985+
/// the job.
59775986
/// You can specify the global instance template as a full or partial URL.
59785987
/// </summary>
59795988
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]

0 commit comments

Comments
 (0)