Package com.google.cloud.dataproc.v1

Class Batch

  • All Implemented Interfaces:
    BatchOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Batch
extends com.google.protobuf.GeneratedMessageV3
implements BatchOrBuilder
     A representation of a batch workload in the service.
    Protobuf type google.cloud.dataproc.v1.Batch
    See Also:
    Serialized Form

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The resource name of the batch.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface BatchOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the batch.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface BatchOrBuilder
        Returns:
        The bytes for name.

      • getUuid

        public String getUuid()
         Output only. A batch UUID (Unique Universal Identifier). The service
 generates this value when it creates the batch.
        string uuid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUuid in interface BatchOrBuilder
        Returns:
        The uuid.

      • getUuidBytes

        public com.google.protobuf.ByteString getUuidBytes()
         Output only. A batch UUID (Unique Universal Identifier). The service
 generates this value when it creates the batch.
        string uuid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUuidBytes in interface BatchOrBuilder
        Returns:
        The bytes for uuid.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time when the batch was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface BatchOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the batch was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface BatchOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the batch was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface BatchOrBuilder

      • hasPysparkBatch

        public boolean hasPysparkBatch()
         Optional. PySpark batch config.
        .google.cloud.dataproc.v1.PySparkBatch pyspark_batch = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasPysparkBatch in interface BatchOrBuilder
        Returns:
        Whether the pysparkBatch field is set.

      • getPysparkBatch

        public PySparkBatch getPysparkBatch()
         Optional. PySpark batch config.
        .google.cloud.dataproc.v1.PySparkBatch pyspark_batch = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPysparkBatch in interface BatchOrBuilder
        Returns:
        The pysparkBatch.

      • hasSparkBatch

        public boolean hasSparkBatch()
         Optional. Spark batch config.
        .google.cloud.dataproc.v1.SparkBatch spark_batch = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasSparkBatch in interface BatchOrBuilder
        Returns:
        Whether the sparkBatch field is set.

      • getSparkBatch

        public SparkBatch getSparkBatch()
         Optional. Spark batch config.
        .google.cloud.dataproc.v1.SparkBatch spark_batch = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSparkBatch in interface BatchOrBuilder
        Returns:
        The sparkBatch.

      • hasSparkRBatch

        public boolean hasSparkRBatch()
         Optional. SparkR batch config.
        .google.cloud.dataproc.v1.SparkRBatch spark_r_batch = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasSparkRBatch in interface BatchOrBuilder
        Returns:
        Whether the sparkRBatch field is set.

      • getSparkRBatch

        public SparkRBatch getSparkRBatch()
         Optional. SparkR batch config.
        .google.cloud.dataproc.v1.SparkRBatch spark_r_batch = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSparkRBatch in interface BatchOrBuilder
        Returns:
        The sparkRBatch.

      • hasSparkSqlBatch

        public boolean hasSparkSqlBatch()
         Optional. SparkSql batch config.
        .google.cloud.dataproc.v1.SparkSqlBatch spark_sql_batch = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasSparkSqlBatch in interface BatchOrBuilder
        Returns:
        Whether the sparkSqlBatch field is set.

      • getSparkSqlBatch

        public SparkSqlBatch getSparkSqlBatch()
         Optional. SparkSql batch config.
        .google.cloud.dataproc.v1.SparkSqlBatch spark_sql_batch = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSparkSqlBatch in interface BatchOrBuilder
        Returns:
        The sparkSqlBatch.

      • hasRuntimeInfo

        public boolean hasRuntimeInfo()
         Output only. Runtime information about batch execution.
        .google.cloud.dataproc.v1.RuntimeInfo runtime_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasRuntimeInfo in interface BatchOrBuilder
        Returns:
        Whether the runtimeInfo field is set.

      • getRuntimeInfo

        public RuntimeInfo getRuntimeInfo()
         Output only. Runtime information about batch execution.
        .google.cloud.dataproc.v1.RuntimeInfo runtime_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getRuntimeInfo in interface BatchOrBuilder
        Returns:
        The runtimeInfo.

      • getRuntimeInfoOrBuilder

        public RuntimeInfoOrBuilder getRuntimeInfoOrBuilder()
         Output only. Runtime information about batch execution.
        .google.cloud.dataproc.v1.RuntimeInfo runtime_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getRuntimeInfoOrBuilder in interface BatchOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. The state of the batch.
        .google.cloud.dataproc.v1.Batch.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface BatchOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Batch.State getState()
         Output only. The state of the batch.
        .google.cloud.dataproc.v1.Batch.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface BatchOrBuilder
        Returns:
        The state.

      • getStateMessage

        public String getStateMessage()
         Output only. Batch state details, such as a failure
 description if the state is `FAILED`.
        string state_message = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateMessage in interface BatchOrBuilder
        Returns:
        The stateMessage.

      • getStateMessageBytes

        public com.google.protobuf.ByteString getStateMessageBytes()
         Output only. Batch state details, such as a failure
 description if the state is `FAILED`.
        string state_message = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateMessageBytes in interface BatchOrBuilder
        Returns:
        The bytes for stateMessage.

      • hasStateTime

        public boolean hasStateTime()
         Output only. The time when the batch entered a current state.
        .google.protobuf.Timestamp state_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStateTime in interface BatchOrBuilder
        Returns:
        Whether the stateTime field is set.

      • getStateTime

        public com.google.protobuf.Timestamp getStateTime()
         Output only. The time when the batch entered a current state.
        .google.protobuf.Timestamp state_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateTime in interface BatchOrBuilder
        Returns:
        The stateTime.

      • getStateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStateTimeOrBuilder()
         Output only. The time when the batch entered a current state.
        .google.protobuf.Timestamp state_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateTimeOrBuilder in interface BatchOrBuilder

      • getCreator

        public String getCreator()
         Output only. The email address of the user who created the batch.
        string creator = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreator in interface BatchOrBuilder
        Returns:
        The creator.

      • getCreatorBytes

        public com.google.protobuf.ByteString getCreatorBytes()
         Output only. The email address of the user who created the batch.
        string creator = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreatorBytes in interface BatchOrBuilder
        Returns:
        The bytes for creator.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: BatchOrBuilder
         Optional. The labels to associate with this batch.
 Label **keys** must contain 1 to 63 characters, and must conform to
 [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
 Label **values** may be empty, but, if present, must contain 1 to 63
 characters, and must conform to [RFC
 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
 associated with a batch.
        map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface BatchOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional. The labels to associate with this batch.
 Label **keys** must contain 1 to 63 characters, and must conform to
 [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
 Label **values** may be empty, but, if present, must contain 1 to 63
 characters, and must conform to [RFC
 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
 associated with a batch.
        map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface BatchOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. The labels to associate with this batch.
 Label **keys** must contain 1 to 63 characters, and must conform to
 [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
 Label **values** may be empty, but, if present, must contain 1 to 63
 characters, and must conform to [RFC
 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
 associated with a batch.
        map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface BatchOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional. The labels to associate with this batch.
 Label **keys** must contain 1 to 63 characters, and must conform to
 [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
 Label **values** may be empty, but, if present, must contain 1 to 63
 characters, and must conform to [RFC
 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
 associated with a batch.
        map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface BatchOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. The labels to associate with this batch.
 Label **keys** must contain 1 to 63 characters, and must conform to
 [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
 Label **values** may be empty, but, if present, must contain 1 to 63
 characters, and must conform to [RFC
 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
 associated with a batch.
        map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface BatchOrBuilder

      • hasRuntimeConfig

        public boolean hasRuntimeConfig()
         Optional. Runtime configuration for the batch execution.
        .google.cloud.dataproc.v1.RuntimeConfig runtime_config = 14 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasRuntimeConfig in interface BatchOrBuilder
        Returns:
        Whether the runtimeConfig field is set.

      • getRuntimeConfig

        public RuntimeConfig getRuntimeConfig()
         Optional. Runtime configuration for the batch execution.
        .google.cloud.dataproc.v1.RuntimeConfig runtime_config = 14 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRuntimeConfig in interface BatchOrBuilder
        Returns:
        The runtimeConfig.

      • getRuntimeConfigOrBuilder

        public RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()
         Optional. Runtime configuration for the batch execution.
        .google.cloud.dataproc.v1.RuntimeConfig runtime_config = 14 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRuntimeConfigOrBuilder in interface BatchOrBuilder

      • hasEnvironmentConfig

        public boolean hasEnvironmentConfig()
         Optional. Environment configuration for the batch execution.
        .google.cloud.dataproc.v1.EnvironmentConfig environment_config = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasEnvironmentConfig in interface BatchOrBuilder
        Returns:
        Whether the environmentConfig field is set.

      • getEnvironmentConfig

        public EnvironmentConfig getEnvironmentConfig()
         Optional. Environment configuration for the batch execution.
        .google.cloud.dataproc.v1.EnvironmentConfig environment_config = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnvironmentConfig in interface BatchOrBuilder
        Returns:
        The environmentConfig.

      • getEnvironmentConfigOrBuilder

        public EnvironmentConfigOrBuilder getEnvironmentConfigOrBuilder()
         Optional. Environment configuration for the batch execution.
        .google.cloud.dataproc.v1.EnvironmentConfig environment_config = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnvironmentConfigOrBuilder in interface BatchOrBuilder

      • getOperation

        public String getOperation()
         Output only. The resource name of the operation associated with this batch.
        string operation = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getOperation in interface BatchOrBuilder
        Returns:
        The operation.

      • getOperationBytes

        public com.google.protobuf.ByteString getOperationBytes()
         Output only. The resource name of the operation associated with this batch.
        string operation = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getOperationBytes in interface BatchOrBuilder
        Returns:
        The bytes for operation.

      • getStateHistoryList

        public List<Batch.StateHistory> getStateHistoryList()
         Output only. Historical state information for the batch.
        repeated .google.cloud.dataproc.v1.Batch.StateHistory state_history = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateHistoryList in interface BatchOrBuilder

      • getStateHistoryCount

        public int getStateHistoryCount()
         Output only. Historical state information for the batch.
        repeated .google.cloud.dataproc.v1.Batch.StateHistory state_history = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateHistoryCount in interface BatchOrBuilder

      • getStateHistory

        public Batch.StateHistory getStateHistory​(int index)
         Output only. Historical state information for the batch.
        repeated .google.cloud.dataproc.v1.Batch.StateHistory state_history = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateHistory in interface BatchOrBuilder

      • getStateHistoryOrBuilder

        public Batch.StateHistoryOrBuilder getStateHistoryOrBuilder​(int index)
         Output only. Historical state information for the batch.
        repeated .google.cloud.dataproc.v1.Batch.StateHistory state_history = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateHistoryOrBuilder in interface BatchOrBuilder

      • 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 Batch parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Batch parseFrom​(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Batch parseFrom​(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Batch parseFrom​(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Batch parseFrom​(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Batch parseFrom​(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Batch parseFrom​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Batch.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Batch.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Batch.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Batch getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Batch> 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 Batch getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder