Google Cloud Batch V1 Client - Class LogsPolicy (1.2.2)

Reference documentation and code samples for the Google Cloud Batch V1 Client class LogsPolicy.

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

Namespace

Google \ Cloud \ Batch \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ destination
int

If and where logs should be saved.

↳ logs_path
string

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/ .

↳ cloud_logging_option
LogsPolicy\CloudLoggingOption

Optional. When destination is set to CLOUD_LOGGING , you can optionally set this field to configure additional settings for Cloud Logging.

getDestination

If and where logs should be saved.

Returns
Type
Description
int

setDestination

If and where logs should be saved.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getLogsPath

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/ .

Returns
Type
Description
string

setLogsPath

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/ .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCloudLoggingOption

Optional. When destination is set to CLOUD_LOGGING , you can optionally set this field to configure additional settings for Cloud Logging.

Returns
Type
Description

hasCloudLoggingOption

clearCloudLoggingOption

setCloudLoggingOption

Optional. When destination is set to CLOUD_LOGGING , you can optionally set this field to configure additional settings for Cloud Logging.

Parameter
Name
Description
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: