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.v1.LogsPolicy
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public LogsPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public LogsPolicy build()
buildPartial()
public LogsPolicy buildPartial()
clear()
public LogsPolicy.Builder clear()
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.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];
clearDestination()
public LogsPolicy.Builder clearDestination()
If and where logs should be saved.
.google.cloud.batch.v1.LogsPolicy.Destination destination = 1;
clearField(Descriptors.FieldDescriptor field)
public LogsPolicy.Builder clearField(Descriptors.FieldDescriptor field)
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public LogsPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public LogsPolicy.Builder clone()
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.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];
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.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];
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.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public LogsPolicy getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getDestination()
public LogsPolicy.Destination getDestination()
If and where logs should be saved.
.google.cloud.batch.v1.LogsPolicy.Destination destination = 1;
getDestinationValue()
public int getDestinationValue()
If and where logs should be saved.
.google.cloud.batch.v1.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.v1.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()
Overrides
isInitialized()
public final boolean isInitialized()
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.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];
mergeFrom(LogsPolicy other)
public LogsPolicy.Builder mergeFrom(LogsPolicy other)
public LogsPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public LogsPolicy.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final LogsPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];
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.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];
setDestination(LogsPolicy.Destination value)
public LogsPolicy.Builder setDestination(LogsPolicy.Destination value)
If and where logs should be saved.
.google.cloud.batch.v1.LogsPolicy.Destination destination = 1;
setDestinationValue(int value)
public LogsPolicy.Builder setDestinationValue(int value)
If and where logs should be saved.
.google.cloud.batch.v1.LogsPolicy.Destination destination = 1;
| Parameter |
| Name |
Description |
value |
int
The enum numeric value on the wire for destination to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public LogsPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
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.
|
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.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public LogsPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final LogsPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
