Google Cloud Batch V1 Client - Class LogsPolicy (1.0.3)

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

LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.

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

Where logs should be saved.

↳ logs_path string

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.

↳ cloud_logging_option Google\Cloud\Batch\V1\LogsPolicy\CloudLoggingOption

Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.

getDestination

Where logs should be saved.

Returns
Type Description
int

setDestination

Where logs should be saved.

Parameter
Name Description
var int
Returns
Type Description
$this

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.

Returns
Type Description
string

setLogsPath

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getCloudLoggingOption

Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.

Returns
Type Description
Google\Cloud\Batch\V1\LogsPolicy\CloudLoggingOption|null

hasCloudLoggingOption

clearCloudLoggingOption

setCloudLoggingOption

Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.

Parameter
Name Description
var Google\Cloud\Batch\V1\LogsPolicy\CloudLoggingOption
Returns
Type Description
$this