From 4e50c739e4e2375bdcbcbe8ca2da149f6d76a270 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 5 Dec 2024 07:03:04 +0000 Subject: [PATCH] docs: clarify options for logs docs: Clarify the custom instance template needs to be in the same project PiperOrigin-RevId: 702966613 Source-Link: https://github.com/googleapis/googleapis/commit/2cb4e7a6f328b0a017e040e2c6150c17ef6bea61 Source-Link: https://github.com/googleapis/googleapis-gen/commit/14a9205201b8000a2fedda894e105256ceed9075 Copy-Tag: eyJwIjoiYXBpcy9Hb29nbGUuQ2xvdWQuQmF0Y2guVjFBbHBoYS8uT3dsQm90LnlhbWwiLCJoIjoiMTRhOTIwNTIwMWI4MDAwYTJmZWRkYTg5NGUxMDUyNTZjZWVkOTA3NSJ9 --- .../Google.Cloud.Batch.V1Alpha/Job.g.cs | 35 ++++++++++++------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/apis/Google.Cloud.Batch.V1Alpha/Google.Cloud.Batch.V1Alpha/Job.g.cs b/apis/Google.Cloud.Batch.V1Alpha/Google.Cloud.Batch.V1Alpha/Job.g.cs index e91367987606..de4721956006 100644 --- a/apis/Google.Cloud.Batch.V1Alpha/Google.Cloud.Batch.V1Alpha/Job.g.cs +++ b/apis/Google.Cloud.Batch.V1Alpha/Google.Cloud.Batch.V1Alpha/Job.g.cs @@ -974,8 +974,10 @@ public enum SchedulingPolicy { } /// - /// LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be - /// preserved. + /// LogsPolicy describes if and how a job's logs are preserved. Logs include + /// information that is automatically written by the Batch service agent and any + /// information that you configured the job's runnables to write to the `stdout` + /// or `stderr` streams. /// [global::System.Diagnostics.DebuggerDisplayAttribute("{ToString(),nq}")] public sealed partial class LogsPolicy : pb::IMessage @@ -1028,7 +1030,7 @@ public LogsPolicy Clone() { public const int DestinationFieldNumber = 1; private global::Google.Cloud.Batch.V1Alpha.LogsPolicy.Types.Destination destination_ = global::Google.Cloud.Batch.V1Alpha.LogsPolicy.Types.Destination.Unspecified; /// - /// Where logs should be saved. + /// If and where logs should be saved. /// [global::System.Diagnostics.DebuggerNonUserCodeAttribute] [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)] @@ -1043,9 +1045,14 @@ public LogsPolicy Clone() { public const int LogsPathFieldNumber = 2; private string logsPath_ = ""; /// - /// The path to which logs are saved when the destination = PATH. This can be a - /// local file path on the VM, or under the mount point of a Persistent Disk or - /// Filestore, or a Cloud Storage path. + /// When `destination` is set to `PATH`, you must set this field to the path + /// where you want logs to be saved. This path can point to a local directory + /// on the VM or (if congifured) a directory under the mount path of any + /// Cloud Storage bucket, network file system (NFS), or writable persistent + /// disk that is mounted to the job. For example, if the job has a bucket with + /// `mountPath` set to `/mnt/disks/my-bucket`, you can write logs to the + /// root directory of the `remotePath` of that bucket by setting this field to + /// `/mnt/disks/my-bucket/`. /// [global::System.Diagnostics.DebuggerNonUserCodeAttribute] [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)] @@ -1060,8 +1067,8 @@ public string LogsPath { public const int CloudLoggingOptionFieldNumber = 3; private global::Google.Cloud.Batch.V1Alpha.LogsPolicy.Types.CloudLoggingOption cloudLoggingOption_; /// - /// Optional. Additional settings for Cloud Logging. It will only take effect - /// when the destination of `LogsPolicy` is set to `CLOUD_LOGGING`. + /// Optional. When `destination` is set to `CLOUD_LOGGING`, you can optionally + /// set this field to configure additional settings for Cloud Logging. /// [global::System.Diagnostics.DebuggerNonUserCodeAttribute] [global::System.CodeDom.Compiler.GeneratedCode("protoc", null)] @@ -1270,15 +1277,16 @@ public static partial class Types { /// public enum Destination { /// - /// Logs are not preserved. + /// (Default) Logs are not preserved. /// [pbr::OriginalName("DESTINATION_UNSPECIFIED")] Unspecified = 0, /// - /// Logs are streamed to Cloud Logging. + /// Logs are streamed to Cloud Logging. Optionally, you can configure + /// additional settings in the `cloudLoggingOption` field. /// [pbr::OriginalName("CLOUD_LOGGING")] CloudLogging = 1, /// - /// Logs are saved to a file path. + /// Logs are saved to the file path specified in the `logsPath` field. /// [pbr::OriginalName("PATH")] Path = 2, } @@ -1336,7 +1344,7 @@ public CloudLoggingOption Clone() { public const int UseGenericTaskMonitoredResourceFieldNumber = 1; private bool useGenericTaskMonitoredResource_; /// - /// Optional. Set this flag to true to change the [monitored resource + /// Optional. Set this field to `true` to change the [monitored resource /// type](https://cloud.google.com/monitoring/api/resources) for /// Cloud Logging logs generated by this Batch job from /// the @@ -5973,7 +5981,8 @@ public InstancePolicyOrTemplate Clone() { /// Named the field as 'instance_template' instead of 'template' to avoid /// C++ keyword conflict. /// - /// Batch only supports global instance templates. + /// Batch only supports global instance templates from the same project as + /// the job. /// You can specify the global instance template as a full or partial URL. /// [global::System.Diagnostics.DebuggerNonUserCodeAttribute]