Class SparkRBatch

  • All Implemented Interfaces:
    SparkRBatchOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class SparkRBatch
    extends com.google.protobuf.GeneratedMessageV3
    implements SparkRBatchOrBuilder
     A configuration for running an
     [Apache SparkR](https://spark.apache.org/docs/latest/sparkr.html)
     batch workload.
     
    Protobuf type google.cloud.dataproc.v1.SparkRBatch
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SparkRBatch.Builder
      A configuration for running an [Apache SparkR](https://spark.apache.org/docs/latest/sparkr.html) batch workload.
      • 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 Description
      static int ARCHIVE_URIS_FIELD_NUMBER  
      static int ARGS_FIELD_NUMBER  
      static int FILE_URIS_FIELD_NUMBER  
      static int MAIN_R_FILE_URI_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 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
      • getMainRFileUri

        public String getMainRFileUri()
         Required. The HCFS URI of the main R file to use as the driver.
         Must be a `.R` or `.r` file.
         
        string main_r_file_uri = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMainRFileUri in interface SparkRBatchOrBuilder
        Returns:
        The mainRFileUri.
      • getMainRFileUriBytes

        public com.google.protobuf.ByteString getMainRFileUriBytes()
         Required. The HCFS URI of the main R file to use as the driver.
         Must be a `.R` or `.r` file.
         
        string main_r_file_uri = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMainRFileUriBytes in interface SparkRBatchOrBuilder
        Returns:
        The bytes for mainRFileUri.
      • getArgsList

        public com.google.protobuf.ProtocolStringList getArgsList()
         Optional. The arguments to pass to the Spark driver. Do not include
         arguments that can be set as batch properties, such as `--conf`, since a
         collision can occur that causes an incorrect batch submission.
         
        repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArgsList in interface SparkRBatchOrBuilder
        Returns:
        A list containing the args.
      • getArgsCount

        public int getArgsCount()
         Optional. The arguments to pass to the Spark driver. Do not include
         arguments that can be set as batch properties, such as `--conf`, since a
         collision can occur that causes an incorrect batch submission.
         
        repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArgsCount in interface SparkRBatchOrBuilder
        Returns:
        The count of args.
      • getArgs

        public String getArgs​(int index)
         Optional. The arguments to pass to the Spark driver. Do not include
         arguments that can be set as batch properties, such as `--conf`, since a
         collision can occur that causes an incorrect batch submission.
         
        repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArgs in interface SparkRBatchOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The args at the given index.
      • getArgsBytes

        public com.google.protobuf.ByteString getArgsBytes​(int index)
         Optional. The arguments to pass to the Spark driver. Do not include
         arguments that can be set as batch properties, such as `--conf`, since a
         collision can occur that causes an incorrect batch submission.
         
        repeated string args = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArgsBytes in interface SparkRBatchOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the args at the given index.
      • getFileUrisList

        public com.google.protobuf.ProtocolStringList getFileUrisList()
         Optional. HCFS URIs of files to be placed in the working directory of
         each executor.
         
        repeated string file_uris = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFileUrisList in interface SparkRBatchOrBuilder
        Returns:
        A list containing the fileUris.
      • getFileUrisCount

        public int getFileUrisCount()
         Optional. HCFS URIs of files to be placed in the working directory of
         each executor.
         
        repeated string file_uris = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFileUrisCount in interface SparkRBatchOrBuilder
        Returns:
        The count of fileUris.
      • getFileUris

        public String getFileUris​(int index)
         Optional. HCFS URIs of files to be placed in the working directory of
         each executor.
         
        repeated string file_uris = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFileUris in interface SparkRBatchOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The fileUris at the given index.
      • getFileUrisBytes

        public com.google.protobuf.ByteString getFileUrisBytes​(int index)
         Optional. HCFS URIs of files to be placed in the working directory of
         each executor.
         
        repeated string file_uris = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFileUrisBytes in interface SparkRBatchOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the fileUris at the given index.
      • getArchiveUrisList

        public com.google.protobuf.ProtocolStringList getArchiveUrisList()
         Optional. HCFS URIs of archives to be extracted into the working directory
         of each executor. Supported file types:
         `.jar`, `.tar`, `.tar.gz`, `.tgz`, and `.zip`.
         
        repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArchiveUrisList in interface SparkRBatchOrBuilder
        Returns:
        A list containing the archiveUris.
      • getArchiveUrisCount

        public int getArchiveUrisCount()
         Optional. HCFS URIs of archives to be extracted into the working directory
         of each executor. Supported file types:
         `.jar`, `.tar`, `.tar.gz`, `.tgz`, and `.zip`.
         
        repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArchiveUrisCount in interface SparkRBatchOrBuilder
        Returns:
        The count of archiveUris.
      • getArchiveUris

        public String getArchiveUris​(int index)
         Optional. HCFS URIs of archives to be extracted into the working directory
         of each executor. Supported file types:
         `.jar`, `.tar`, `.tar.gz`, `.tgz`, and `.zip`.
         
        repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArchiveUris in interface SparkRBatchOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The archiveUris at the given index.
      • getArchiveUrisBytes

        public com.google.protobuf.ByteString getArchiveUrisBytes​(int index)
         Optional. HCFS URIs of archives to be extracted into the working directory
         of each executor. Supported file types:
         `.jar`, `.tar`, `.tar.gz`, `.tgz`, and `.zip`.
         
        repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArchiveUrisBytes in interface SparkRBatchOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the archiveUris at the given index.
      • 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 SparkRBatch parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static SparkRBatch getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<SparkRBatch> parser()
      • getParserForType

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