Class LogsPolicy.Builder (0.55.0)

public static final class LogsPolicy.Builder extends GeneratedMessageV3.Builder<LogsPolicy.Builder> implements LogsPolicyOrBuilder

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.

Protobuf type google.cloud.batch.v1alpha.LogsPolicy

Implements

LogsPolicyOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LogsPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LogsPolicy.Builder
Overrides

build()

public LogsPolicy build()
Returns
Type Description
LogsPolicy

buildPartial()

public LogsPolicy buildPartial()
Returns
Type Description
LogsPolicy

clear()

public LogsPolicy.Builder clear()
Returns
Type Description
LogsPolicy.Builder
Overrides

clearCloudLoggingOption()

public LogsPolicy.Builder clearCloudLoggingOption()

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

.google.cloud.batch.v1alpha.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LogsPolicy.Builder

clearDestination()

public LogsPolicy.Builder clearDestination()

If and where logs should be saved.

.google.cloud.batch.v1alpha.LogsPolicy.Destination destination = 1;

Returns
Type Description
LogsPolicy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public LogsPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
LogsPolicy.Builder
Overrides

clearLogsPath()

public LogsPolicy.Builder clearLogsPath()

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

string logs_path = 2;

Returns
Type Description
LogsPolicy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LogsPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
LogsPolicy.Builder
Overrides

clone()

public LogsPolicy.Builder clone()
Returns
Type Description
LogsPolicy.Builder
Overrides

getCloudLoggingOption()

public LogsPolicy.CloudLoggingOption getCloudLoggingOption()

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

.google.cloud.batch.v1alpha.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LogsPolicy.CloudLoggingOption

The cloudLoggingOption.

getCloudLoggingOptionBuilder()

public LogsPolicy.CloudLoggingOption.Builder getCloudLoggingOptionBuilder()

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

.google.cloud.batch.v1alpha.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LogsPolicy.CloudLoggingOption.Builder

getCloudLoggingOptionOrBuilder()

public LogsPolicy.CloudLoggingOptionOrBuilder getCloudLoggingOptionOrBuilder()

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

.google.cloud.batch.v1alpha.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LogsPolicy.CloudLoggingOptionOrBuilder

getDefaultInstanceForType()

public LogsPolicy getDefaultInstanceForType()
Returns
Type Description
LogsPolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDestination()

public LogsPolicy.Destination getDestination()

If and where logs should be saved.

.google.cloud.batch.v1alpha.LogsPolicy.Destination destination = 1;

Returns
Type Description
LogsPolicy.Destination

The destination.

getDestinationValue()

public int getDestinationValue()

If and where logs should be saved.

.google.cloud.batch.v1alpha.LogsPolicy.Destination destination = 1;

Returns
Type Description
int

The enum numeric value on the wire for destination.

getLogsPath()

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

string logs_path = 2;

Returns
Type Description
String

The logsPath.

getLogsPathBytes()

public ByteString getLogsPathBytes()

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

string logs_path = 2;

Returns
Type Description
ByteString

The bytes for logsPath.

hasCloudLoggingOption()

public boolean hasCloudLoggingOption()

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

.google.cloud.batch.v1alpha.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the cloudLoggingOption field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCloudLoggingOption(LogsPolicy.CloudLoggingOption value)

public LogsPolicy.Builder mergeCloudLoggingOption(LogsPolicy.CloudLoggingOption value)

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

.google.cloud.batch.v1alpha.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LogsPolicy.CloudLoggingOption
Returns
Type Description
LogsPolicy.Builder

mergeFrom(LogsPolicy other)

public LogsPolicy.Builder mergeFrom(LogsPolicy other)
Parameter
Name Description
other LogsPolicy
Returns
Type Description
LogsPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LogsPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogsPolicy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public LogsPolicy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
LogsPolicy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LogsPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LogsPolicy.Builder
Overrides

setCloudLoggingOption(LogsPolicy.CloudLoggingOption value)

public LogsPolicy.Builder setCloudLoggingOption(LogsPolicy.CloudLoggingOption value)

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

.google.cloud.batch.v1alpha.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LogsPolicy.CloudLoggingOption
Returns
Type Description
LogsPolicy.Builder

setCloudLoggingOption(LogsPolicy.CloudLoggingOption.Builder builderForValue)

public LogsPolicy.Builder setCloudLoggingOption(LogsPolicy.CloudLoggingOption.Builder builderForValue)

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

.google.cloud.batch.v1alpha.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue LogsPolicy.CloudLoggingOption.Builder
Returns
Type Description
LogsPolicy.Builder

setDestination(LogsPolicy.Destination value)

public LogsPolicy.Builder setDestination(LogsPolicy.Destination value)

If and where logs should be saved.

.google.cloud.batch.v1alpha.LogsPolicy.Destination destination = 1;

Parameter
Name Description
value LogsPolicy.Destination

The destination to set.

Returns
Type Description
LogsPolicy.Builder

This builder for chaining.

setDestinationValue(int value)

public LogsPolicy.Builder setDestinationValue(int value)

If and where logs should be saved.

.google.cloud.batch.v1alpha.LogsPolicy.Destination destination = 1;

Parameter
Name Description
value int

The enum numeric value on the wire for destination to set.

Returns
Type Description
LogsPolicy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public LogsPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LogsPolicy.Builder
Overrides

setLogsPath(String value)

public LogsPolicy.Builder setLogsPath(String value)

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

string logs_path = 2;

Parameter
Name Description
value String

The logsPath to set.

Returns
Type Description
LogsPolicy.Builder

This builder for chaining.

setLogsPathBytes(ByteString value)

public LogsPolicy.Builder setLogsPathBytes(ByteString value)

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

string logs_path = 2;

Parameter
Name Description
value ByteString

The bytes for logsPath to set.

Returns
Type Description
LogsPolicy.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public LogsPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
LogsPolicy.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final LogsPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LogsPolicy.Builder
Overrides