Class LogsPolicy (0.55.0)

public final class LogsPolicy extends GeneratedMessageV3 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

Implements

LogsPolicyOrBuilder

Static Fields

CLOUD_LOGGING_OPTION_FIELD_NUMBER

public static final int CLOUD_LOGGING_OPTION_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_FIELD_NUMBER

public static final int DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

LOGS_PATH_FIELD_NUMBER

public static final int LOGS_PATH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LogsPolicy getDefaultInstance()
Returns
Type Description
LogsPolicy

getDescriptor()

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

newBuilder()

public static LogsPolicy.Builder newBuilder()
Returns
Type Description
LogsPolicy.Builder

newBuilder(LogsPolicy prototype)

public static LogsPolicy.Builder newBuilder(LogsPolicy prototype)
Parameter
Name Description
prototype LogsPolicy
Returns
Type Description
LogsPolicy.Builder

parseDelimitedFrom(InputStream input)

public static LogsPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LogsPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LogsPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogsPolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LogsPolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LogsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LogsPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LogsPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LogsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LogsPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LogsPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LogsPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LogsPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogsPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LogsPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LogsPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LogsPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogsPolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LogsPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LogsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LogsPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LogsPolicy> parser()
Returns
Type Description
Parser<LogsPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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];

Returns
Type Description
LogsPolicy.CloudLoggingOption

The cloudLoggingOption.

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];

Returns
Type Description
LogsPolicy.CloudLoggingOptionOrBuilder

getDefaultInstanceForType()

public LogsPolicy getDefaultInstanceForType()
Returns
Type Description
LogsPolicy

getDestination()

public LogsPolicy.Destination getDestination()

If and where logs should be saved.

.google.cloud.batch.v1.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.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.

getParserForType()

public Parser<LogsPolicy> getParserForType()
Returns
Type Description
Parser<LogsPolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LogsPolicy.Builder newBuilderForType()
Returns
Type Description
LogsPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LogsPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LogsPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public LogsPolicy.Builder toBuilder()
Returns
Type Description
LogsPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException