Skip to content

Commit

Permalink
docs: clarify options for logs
Browse files Browse the repository at this point in the history
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
  • Loading branch information
gcf-owl-bot[bot] authored and amanda-tarafa committed Dec 5, 2024
1 parent d336935 commit 4e50c73
Showing 1 changed file with 22 additions and 13 deletions.
35 changes: 22 additions & 13 deletions apis/Google.Cloud.Batch.V1Alpha/Google.Cloud.Batch.V1Alpha/Job.g.cs
Original file line number Diff line number Diff line change
Expand Up @@ -974,8 +974,10 @@ public enum SchedulingPolicy {
}

/// <summary>
/// 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.
/// </summary>
[global::System.Diagnostics.DebuggerDisplayAttribute("{ToString(),nq}")]
public sealed partial class LogsPolicy : pb::IMessage<LogsPolicy>
Expand Down Expand Up @@ -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;
/// <summary>
/// Where logs should be saved.
/// If and where logs should be saved.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand All @@ -1043,9 +1045,14 @@ public LogsPolicy Clone() {
public const int LogsPathFieldNumber = 2;
private string logsPath_ = "";
/// <summary>
/// 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/`.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand All @@ -1060,8 +1067,8 @@ public string LogsPath {
public const int CloudLoggingOptionFieldNumber = 3;
private global::Google.Cloud.Batch.V1Alpha.LogsPolicy.Types.CloudLoggingOption cloudLoggingOption_;
/// <summary>
/// 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.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -1270,15 +1277,16 @@ public static partial class Types {
/// </summary>
public enum Destination {
/// <summary>
/// Logs are not preserved.
/// (Default) Logs are not preserved.
/// </summary>
[pbr::OriginalName("DESTINATION_UNSPECIFIED")] Unspecified = 0,
/// <summary>
/// Logs are streamed to Cloud Logging.
/// Logs are streamed to Cloud Logging. Optionally, you can configure
/// additional settings in the `cloudLoggingOption` field.
/// </summary>
[pbr::OriginalName("CLOUD_LOGGING")] CloudLogging = 1,
/// <summary>
/// Logs are saved to a file path.
/// Logs are saved to the file path specified in the `logsPath` field.
/// </summary>
[pbr::OriginalName("PATH")] Path = 2,
}
Expand Down Expand Up @@ -1336,7 +1344,7 @@ public CloudLoggingOption Clone() {
public const int UseGenericTaskMonitoredResourceFieldNumber = 1;
private bool useGenericTaskMonitoredResource_;
/// <summary>
/// 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
Expand Down Expand Up @@ -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.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
Expand Down

0 comments on commit 4e50c73

Please sign in to comment.