Package com.google.cloud.dataproc.v1

Class SparkJob

  • All Implemented Interfaces:
    SparkJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SparkJob
extends com.google.protobuf.GeneratedMessageV3
implements SparkJobOrBuilder
     A Dataproc job for running [Apache Spark](https://spark.apache.org/)
 applications on YARN.
    Protobuf type google.cloud.dataproc.v1.SparkJob
    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

      • hasMainJarFileUri

        public boolean hasMainJarFileUri()
         The HCFS URI of the jar file that contains the main class.
        string main_jar_file_uri = 1;
        Specified by:
        hasMainJarFileUri in interface SparkJobOrBuilder
        Returns:
        Whether the mainJarFileUri field is set.

      • getMainJarFileUri

        public String getMainJarFileUri()
         The HCFS URI of the jar file that contains the main class.
        string main_jar_file_uri = 1;
        Specified by:
        getMainJarFileUri in interface SparkJobOrBuilder
        Returns:
        The mainJarFileUri.

      • getMainJarFileUriBytes

        public com.google.protobuf.ByteString getMainJarFileUriBytes()
         The HCFS URI of the jar file that contains the main class.
        string main_jar_file_uri = 1;
        Specified by:
        getMainJarFileUriBytes in interface SparkJobOrBuilder
        Returns:
        The bytes for mainJarFileUri.

      • hasMainClass

        public boolean hasMainClass()
         The name of the driver's main class. The jar file that contains the class
 must be in the default CLASSPATH or specified in `jar_file_uris`.
        string main_class = 2;
        Specified by:
        hasMainClass in interface SparkJobOrBuilder
        Returns:
        Whether the mainClass field is set.

      • getMainClass

        public String getMainClass()
         The name of the driver's main class. The jar file that contains the class
 must be in the default CLASSPATH or specified in `jar_file_uris`.
        string main_class = 2;
        Specified by:
        getMainClass in interface SparkJobOrBuilder
        Returns:
        The mainClass.

      • getMainClassBytes

        public com.google.protobuf.ByteString getMainClassBytes()
         The name of the driver's main class. The jar file that contains the class
 must be in the default CLASSPATH or specified in `jar_file_uris`.
        string main_class = 2;
        Specified by:
        getMainClassBytes in interface SparkJobOrBuilder
        Returns:
        The bytes for mainClass.

      • getArgsList

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

      • getArgsCount

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

      • getArgs

        public String getArgs​(int index)
         Optional. The arguments to pass to the driver. Do not include arguments,
 such as `--conf`, that can be set as job properties, since a collision may
 occur that causes an incorrect job submission.
        repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArgs in interface SparkJobOrBuilder
        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 driver. Do not include arguments,
 such as `--conf`, that can be set as job properties, since a collision may
 occur that causes an incorrect job submission.
        repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArgsBytes in interface SparkJobOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the args at the given index.

      • getJarFileUrisList

        public com.google.protobuf.ProtocolStringList getJarFileUrisList()
         Optional. HCFS URIs of jar files to add to the CLASSPATHs of the
 Spark driver and tasks.
        repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getJarFileUrisList in interface SparkJobOrBuilder
        Returns:
        A list containing the jarFileUris.

      • getJarFileUrisCount

        public int getJarFileUrisCount()
         Optional. HCFS URIs of jar files to add to the CLASSPATHs of the
 Spark driver and tasks.
        repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getJarFileUrisCount in interface SparkJobOrBuilder
        Returns:
        The count of jarFileUris.

      • getJarFileUris

        public String getJarFileUris​(int index)
         Optional. HCFS URIs of jar files to add to the CLASSPATHs of the
 Spark driver and tasks.
        repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getJarFileUris in interface SparkJobOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The jarFileUris at the given index.

      • getJarFileUrisBytes

        public com.google.protobuf.ByteString getJarFileUrisBytes​(int index)
         Optional. HCFS URIs of jar files to add to the CLASSPATHs of the
 Spark driver and tasks.
        repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getJarFileUrisBytes in interface SparkJobOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the jarFileUris 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. Useful for naively parallel tasks.
        repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFileUrisList in interface SparkJobOrBuilder
        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. Useful for naively parallel tasks.
        repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFileUrisCount in interface SparkJobOrBuilder
        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. Useful for naively parallel tasks.
        repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFileUris in interface SparkJobOrBuilder
        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. Useful for naively parallel tasks.
        repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFileUrisBytes in interface SparkJobOrBuilder
        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 = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArchiveUrisList in interface SparkJobOrBuilder
        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 = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArchiveUrisCount in interface SparkJobOrBuilder
        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 = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArchiveUris in interface SparkJobOrBuilder
        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 = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArchiveUrisBytes in interface SparkJobOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the archiveUris at the given index.

      • getPropertiesCount

        public int getPropertiesCount()
        Description copied from interface: SparkJobOrBuilder
         Optional. A mapping of property names to values, used to configure Spark.
 Properties that conflict with values set by the Dataproc API may be
 overwritten. Can include properties set in
 /etc/spark/conf/spark-defaults.conf and classes in user code.
        map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesCount in interface SparkJobOrBuilder

      • containsProperties

        public boolean containsProperties​(String key)
         Optional. A mapping of property names to values, used to configure Spark.
 Properties that conflict with values set by the Dataproc API may be
 overwritten. Can include properties set in
 /etc/spark/conf/spark-defaults.conf and classes in user code.
        map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsProperties in interface SparkJobOrBuilder

      • getPropertiesMap

        public Map<String,​String> getPropertiesMap()
         Optional. A mapping of property names to values, used to configure Spark.
 Properties that conflict with values set by the Dataproc API may be
 overwritten. Can include properties set in
 /etc/spark/conf/spark-defaults.conf and classes in user code.
        map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesMap in interface SparkJobOrBuilder

      • getPropertiesOrDefault

        public String getPropertiesOrDefault​(String key,
                                     String defaultValue)
         Optional. A mapping of property names to values, used to configure Spark.
 Properties that conflict with values set by the Dataproc API may be
 overwritten. Can include properties set in
 /etc/spark/conf/spark-defaults.conf and classes in user code.
        map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesOrDefault in interface SparkJobOrBuilder

      • getPropertiesOrThrow

        public String getPropertiesOrThrow​(String key)
         Optional. A mapping of property names to values, used to configure Spark.
 Properties that conflict with values set by the Dataproc API may be
 overwritten. Can include properties set in
 /etc/spark/conf/spark-defaults.conf and classes in user code.
        map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesOrThrow in interface SparkJobOrBuilder

      • hasLoggingConfig

        public boolean hasLoggingConfig()
         Optional. The runtime log config for job execution.
        .google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasLoggingConfig in interface SparkJobOrBuilder
        Returns:
        Whether the loggingConfig field is set.

      • getLoggingConfig

        public LoggingConfig getLoggingConfig()
         Optional. The runtime log config for job execution.
        .google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLoggingConfig in interface SparkJobOrBuilder
        Returns:
        The loggingConfig.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static SparkJob getDefaultInstance()

      • parser

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

      • getParserForType

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