Class HiveJob

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

    public final class HiveJob
    extends com.google.protobuf.GeneratedMessageV3
    implements HiveJobOrBuilder
     A Dataproc job for running [Apache Hive](https://hive.apache.org/)
     queries on YARN.
     
    Protobuf type google.cloud.dataproc.v1.HiveJob
    See Also:
    Serialized Form
    • Field Detail

      • QUERY_FILE_URI_FIELD_NUMBER

        public static final int QUERY_FILE_URI_FIELD_NUMBER
        See Also:
        Constant Field Values
      • QUERY_LIST_FIELD_NUMBER

        public static final int QUERY_LIST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CONTINUE_ON_FAILURE_FIELD_NUMBER

        public static final int CONTINUE_ON_FAILURE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SCRIPT_VARIABLES_FIELD_NUMBER

        public static final int SCRIPT_VARIABLES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PROPERTIES_FIELD_NUMBER

        public static final int PROPERTIES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • JAR_FILE_URIS_FIELD_NUMBER

        public static final int JAR_FILE_URIS_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()
      • 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
      • hasQueryFileUri

        public boolean hasQueryFileUri()
         The HCFS URI of the script that contains Hive queries.
         
        string query_file_uri = 1;
        Specified by:
        hasQueryFileUri in interface HiveJobOrBuilder
        Returns:
        Whether the queryFileUri field is set.
      • getQueryFileUri

        public String getQueryFileUri()
         The HCFS URI of the script that contains Hive queries.
         
        string query_file_uri = 1;
        Specified by:
        getQueryFileUri in interface HiveJobOrBuilder
        Returns:
        The queryFileUri.
      • getQueryFileUriBytes

        public com.google.protobuf.ByteString getQueryFileUriBytes()
         The HCFS URI of the script that contains Hive queries.
         
        string query_file_uri = 1;
        Specified by:
        getQueryFileUriBytes in interface HiveJobOrBuilder
        Returns:
        The bytes for queryFileUri.
      • hasQueryList

        public boolean hasQueryList()
         A list of queries.
         
        .google.cloud.dataproc.v1.QueryList query_list = 2;
        Specified by:
        hasQueryList in interface HiveJobOrBuilder
        Returns:
        Whether the queryList field is set.
      • getQueryList

        public QueryList getQueryList()
         A list of queries.
         
        .google.cloud.dataproc.v1.QueryList query_list = 2;
        Specified by:
        getQueryList in interface HiveJobOrBuilder
        Returns:
        The queryList.
      • getContinueOnFailure

        public boolean getContinueOnFailure()
         Optional. Whether to continue executing queries if a query fails.
         The default value is `false`. Setting to `true` can be useful when
         executing independent parallel queries.
         
        bool continue_on_failure = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getContinueOnFailure in interface HiveJobOrBuilder
        Returns:
        The continueOnFailure.
      • getScriptVariablesCount

        public int getScriptVariablesCount()
        Description copied from interface: HiveJobOrBuilder
         Optional. Mapping of query variable names to values (equivalent to the
         Hive command: `SET name="value";`).
         
        map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getScriptVariablesCount in interface HiveJobOrBuilder
      • containsScriptVariables

        public boolean containsScriptVariables​(String key)
         Optional. Mapping of query variable names to values (equivalent to the
         Hive command: `SET name="value";`).
         
        map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsScriptVariables in interface HiveJobOrBuilder
      • getScriptVariablesMap

        public Map<String,​String> getScriptVariablesMap()
         Optional. Mapping of query variable names to values (equivalent to the
         Hive command: `SET name="value";`).
         
        map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getScriptVariablesMap in interface HiveJobOrBuilder
      • getScriptVariablesOrDefault

        public String getScriptVariablesOrDefault​(String key,
                                                  String defaultValue)
         Optional. Mapping of query variable names to values (equivalent to the
         Hive command: `SET name="value";`).
         
        map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getScriptVariablesOrDefault in interface HiveJobOrBuilder
      • getScriptVariablesOrThrow

        public String getScriptVariablesOrThrow​(String key)
         Optional. Mapping of query variable names to values (equivalent to the
         Hive command: `SET name="value";`).
         
        map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getScriptVariablesOrThrow in interface HiveJobOrBuilder
      • getPropertiesCount

        public int getPropertiesCount()
        Description copied from interface: HiveJobOrBuilder
         Optional. A mapping of property names and values, used to configure Hive.
         Properties that conflict with values set by the Dataproc API may be
         overwritten. Can include properties set in `/etc/hadoop/conf/*-site.xml`,
         /etc/hive/conf/hive-site.xml, and classes in user code.
         
        map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesCount in interface HiveJobOrBuilder
      • containsProperties

        public boolean containsProperties​(String key)
         Optional. A mapping of property names and values, used to configure Hive.
         Properties that conflict with values set by the Dataproc API may be
         overwritten. Can include properties set in `/etc/hadoop/conf/*-site.xml`,
         /etc/hive/conf/hive-site.xml, and classes in user code.
         
        map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsProperties in interface HiveJobOrBuilder
      • getPropertiesMap

        public Map<String,​String> getPropertiesMap()
         Optional. A mapping of property names and values, used to configure Hive.
         Properties that conflict with values set by the Dataproc API may be
         overwritten. Can include properties set in `/etc/hadoop/conf/*-site.xml`,
         /etc/hive/conf/hive-site.xml, and classes in user code.
         
        map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesMap in interface HiveJobOrBuilder
      • getPropertiesOrDefault

        public String getPropertiesOrDefault​(String key,
                                             String defaultValue)
         Optional. A mapping of property names and values, used to configure Hive.
         Properties that conflict with values set by the Dataproc API may be
         overwritten. Can include properties set in `/etc/hadoop/conf/*-site.xml`,
         /etc/hive/conf/hive-site.xml, and classes in user code.
         
        map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesOrDefault in interface HiveJobOrBuilder
      • getPropertiesOrThrow

        public String getPropertiesOrThrow​(String key)
         Optional. A mapping of property names and values, used to configure Hive.
         Properties that conflict with values set by the Dataproc API may be
         overwritten. Can include properties set in `/etc/hadoop/conf/*-site.xml`,
         /etc/hive/conf/hive-site.xml, and classes in user code.
         
        map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesOrThrow in interface HiveJobOrBuilder
      • getJarFileUrisList

        public com.google.protobuf.ProtocolStringList getJarFileUrisList()
         Optional. HCFS URIs of jar files to add to the CLASSPATH of the
         Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes
         and UDFs.
         
        repeated string jar_file_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getJarFileUrisList in interface HiveJobOrBuilder
        Returns:
        A list containing the jarFileUris.
      • getJarFileUrisCount

        public int getJarFileUrisCount()
         Optional. HCFS URIs of jar files to add to the CLASSPATH of the
         Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes
         and UDFs.
         
        repeated string jar_file_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getJarFileUrisCount in interface HiveJobOrBuilder
        Returns:
        The count of jarFileUris.
      • getJarFileUris

        public String getJarFileUris​(int index)
         Optional. HCFS URIs of jar files to add to the CLASSPATH of the
         Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes
         and UDFs.
         
        repeated string jar_file_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getJarFileUris in interface HiveJobOrBuilder
        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 CLASSPATH of the
         Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes
         and UDFs.
         
        repeated string jar_file_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getJarFileUrisBytes in interface HiveJobOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the jarFileUris 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 HiveJob parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static HiveJob getDefaultInstance()
      • parser

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

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