com.google.cloud.batch.v1

Class LogsPolicy

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.batch.v1.LogsPolicy

All Implemented Interfaces:

LogsPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class LogsPolicy
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogsPolicy.Builder LogsPolicy describes if and how a job's logs are preserved.
static class	LogsPolicy.CloudLoggingOption `CloudLoggingOption` contains additional settings for Cloud Logging logs generated by Batch job.
static interface	LogsPolicy.CloudLoggingOptionOrBuilder
static class	LogsPolicy.Destination The destination (if any) for logs.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOUD_LOGGING_OPTION_FIELD_NUMBER
static int	DESTINATION_FIELD_NUMBER
static int	LOGS_PATH_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
LogsPolicy.CloudLoggingOption	getCloudLoggingOption() Optional.
LogsPolicy.CloudLoggingOptionOrBuilder	getCloudLoggingOptionOrBuilder() Optional.
static LogsPolicy	getDefaultInstance()
LogsPolicy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
LogsPolicy.Destination	getDestination() If and where logs should be saved.
int	getDestinationValue() If and where logs should be saved.
String	getLogsPath() When `destination` is set to `PATH`, you must set this field to the path where you want logs to be saved.
com.google.protobuf.ByteString	getLogsPathBytes() When `destination` is set to `PATH`, you must set this field to the path where you want logs to be saved.
com.google.protobuf.Parser<LogsPolicy>	getParserForType()
int	getSerializedSize()
boolean	hasCloudLoggingOption() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LogsPolicy.Builder	newBuilder()
static LogsPolicy.Builder	newBuilder(LogsPolicy prototype)
LogsPolicy.Builder	newBuilderForType()
protected LogsPolicy.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static LogsPolicy	parseDelimitedFrom(InputStream input)
static LogsPolicy	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogsPolicy	parseFrom(byte[] data)
static LogsPolicy	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogsPolicy	parseFrom(ByteBuffer data)
static LogsPolicy	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogsPolicy	parseFrom(com.google.protobuf.ByteString data)
static LogsPolicy	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogsPolicy	parseFrom(com.google.protobuf.CodedInputStream input)
static LogsPolicy	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogsPolicy	parseFrom(InputStream input)
static LogsPolicy	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LogsPolicy>	parser()
LogsPolicy.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DESTINATION_FIELD_NUMBER

public static final int DESTINATION_FIELD_NUMBER

See Also:

Constant Field Values

LOGS_PATH_FIELD_NUMBER

public static final int LOGS_PATH_FIELD_NUMBER

See Also:

Constant Field Values

CLOUD_LOGGING_OPTION_FIELD_NUMBER

public static final int CLOUD_LOGGING_OPTION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getDestinationValue

public int getDestinationValue()

 If and where logs should be saved.
 

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

Specified by:

getDestinationValue in interface LogsPolicyOrBuilder

Returns:

The enum numeric value on the wire for destination.

getDestination

public LogsPolicy.Destination getDestination()

 If and where logs should be saved.
 

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

Specified by:

getDestination in interface LogsPolicyOrBuilder

Returns:

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

Specified by:

getLogsPath in interface LogsPolicyOrBuilder

Returns:

The logsPath.

getLogsPathBytes

public com.google.protobuf.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;

Specified by:

getLogsPathBytes in interface LogsPolicyOrBuilder

Returns:

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

Specified by:

hasCloudLoggingOption in interface LogsPolicyOrBuilder

Returns:

Whether the cloudLoggingOption field is set.

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

Specified by:

getCloudLoggingOption in interface LogsPolicyOrBuilder

Returns:

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

Specified by:

getCloudLoggingOptionOrBuilder in interface LogsPolicyOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static LogsPolicy parseFrom(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogsPolicy parseFrom(ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogsPolicy parseFrom(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogsPolicy parseFrom(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogsPolicy parseFrom(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogsPolicy parseFrom(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogsPolicy parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static LogsPolicy parseFrom(InputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static LogsPolicy parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static LogsPolicy parseDelimitedFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseFrom

public static LogsPolicy parseFrom(com.google.protobuf.CodedInputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static LogsPolicy parseFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

newBuilderForType

public LogsPolicy.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LogsPolicy.Builder newBuilder()

newBuilder

public static LogsPolicy.Builder newBuilder(LogsPolicy prototype)

toBuilder

public LogsPolicy.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LogsPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LogsPolicy getDefaultInstance()

parser

public static com.google.protobuf.Parser<LogsPolicy> parser()

getParserForType

public com.google.protobuf.Parser<LogsPolicy> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public LogsPolicy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder