diff --git a/Batch/src/V1/AllocationPolicy/InstancePolicyOrTemplate.php b/Batch/src/V1/AllocationPolicy/InstancePolicyOrTemplate.php index c6dc0d5bb280..19873d476717 100644 --- a/Batch/src/V1/AllocationPolicy/InstancePolicyOrTemplate.php +++ b/Batch/src/V1/AllocationPolicy/InstancePolicyOrTemplate.php @@ -72,7 +72,8 @@ class InstancePolicyOrTemplate extends \Google\Protobuf\Internal\Message * Name of an instance template used to create VMs. * 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. * @type bool $install_gpu_drivers * Set this field true if you want Batch to help fetch drivers from a third @@ -144,7 +145,8 @@ public function setPolicy($var) * Name of an instance template used to create VMs. * 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. * * Generated from protobuf field string instance_template = 2; @@ -164,7 +166,8 @@ public function hasInstanceTemplate() * Name of an instance template used to create VMs. * 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. * * Generated from protobuf field string instance_template = 2; diff --git a/Batch/src/V1/LogsPolicy.php b/Batch/src/V1/LogsPolicy.php index 3815935a8403..f4f1e486ddb7 100644 --- a/Batch/src/V1/LogsPolicy.php +++ b/Batch/src/V1/LogsPolicy.php @@ -9,30 +9,37 @@ use Google\Protobuf\Internal\GPBUtil; /** - * 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. * * Generated from protobuf message google.cloud.batch.v1.LogsPolicy */ class LogsPolicy extends \Google\Protobuf\Internal\Message { /** - * Where logs should be saved. + * If and where logs should be saved. * * Generated from protobuf field .google.cloud.batch.v1.LogsPolicy.Destination destination = 1; */ protected $destination = 0; /** - * 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/`. * * Generated from protobuf field string logs_path = 2; */ protected $logs_path = ''; /** - * 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. * * Generated from protobuf field .google.cloud.batch.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -45,14 +52,19 @@ class LogsPolicy extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int $destination - * Where logs should be saved. + * If and where logs should be saved. * @type string $logs_path - * 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/`. * @type \Google\Cloud\Batch\V1\LogsPolicy\CloudLoggingOption $cloud_logging_option - * 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. * } */ public function __construct($data = NULL) { @@ -61,7 +73,7 @@ public function __construct($data = NULL) { } /** - * Where logs should be saved. + * If and where logs should be saved. * * Generated from protobuf field .google.cloud.batch.v1.LogsPolicy.Destination destination = 1; * @return int @@ -72,7 +84,7 @@ public function getDestination() } /** - * Where logs should be saved. + * If and where logs should be saved. * * Generated from protobuf field .google.cloud.batch.v1.LogsPolicy.Destination destination = 1; * @param int $var @@ -87,9 +99,14 @@ public function setDestination($var) } /** - * 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/`. * * Generated from protobuf field string logs_path = 2; * @return string @@ -100,9 +117,14 @@ public function getLogsPath() } /** - * 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/`. * * Generated from protobuf field string logs_path = 2; * @param string $var @@ -117,8 +139,8 @@ public function setLogsPath($var) } /** - * 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. * * Generated from protobuf field .google.cloud.batch.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\Batch\V1\LogsPolicy\CloudLoggingOption|null @@ -139,8 +161,8 @@ public function clearCloudLoggingOption() } /** - * 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. * * Generated from protobuf field .google.cloud.batch.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\Batch\V1\LogsPolicy\CloudLoggingOption $var diff --git a/Batch/src/V1/LogsPolicy/CloudLoggingOption.php b/Batch/src/V1/LogsPolicy/CloudLoggingOption.php index 36ccba4a80db..06dbe3685710 100644 --- a/Batch/src/V1/LogsPolicy/CloudLoggingOption.php +++ b/Batch/src/V1/LogsPolicy/CloudLoggingOption.php @@ -17,7 +17,7 @@ class CloudLoggingOption extends \Google\Protobuf\Internal\Message { /** - * 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 @@ -37,7 +37,7 @@ class CloudLoggingOption extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $use_generic_task_monitored_resource - * 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 @@ -53,7 +53,7 @@ public function __construct($data = NULL) { } /** - * 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 @@ -71,7 +71,7 @@ public function getUseGenericTaskMonitoredResource() } /** - * 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 diff --git a/Batch/src/V1/LogsPolicy/Destination.php b/Batch/src/V1/LogsPolicy/Destination.php index 312c27408f9b..8d2a3cca487f 100644 --- a/Batch/src/V1/LogsPolicy/Destination.php +++ b/Batch/src/V1/LogsPolicy/Destination.php @@ -14,19 +14,20 @@ class Destination { /** - * Logs are not preserved. + * (Default) Logs are not preserved. * * Generated from protobuf enum DESTINATION_UNSPECIFIED = 0; */ const DESTINATION_UNSPECIFIED = 0; /** - * Logs are streamed to Cloud Logging. + * Logs are streamed to Cloud Logging. Optionally, you can configure + * additional settings in the `cloudLoggingOption` field. * * Generated from protobuf enum CLOUD_LOGGING = 1; */ const CLOUD_LOGGING = 1; /** - * Logs are saved to a file path. + * Logs are saved to the file path specified in the `logsPath` field. * * Generated from protobuf enum PATH = 2; */