Class HiveJob (4.42.0)

public final class HiveJob extends GeneratedMessageV3 implements HiveJobOrBuilder

A Dataproc job for running Apache Hive queries on YARN.

Protobuf type google.cloud.dataproc.v1.HiveJob

Implements

HiveJobOrBuilder

Static Fields

CONTINUE_ON_FAILURE_FIELD_NUMBER

public static final int CONTINUE_ON_FAILURE_FIELD_NUMBER
Field Value
Type Description
int

JAR_FILE_URIS_FIELD_NUMBER

public static final int JAR_FILE_URIS_FIELD_NUMBER
Field Value
Type Description
int

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FILE_URI_FIELD_NUMBER

public static final int QUERY_FILE_URI_FIELD_NUMBER
Field Value
Type Description
int

QUERY_LIST_FIELD_NUMBER

public static final int QUERY_LIST_FIELD_NUMBER
Field Value
Type Description
int

SCRIPT_VARIABLES_FIELD_NUMBER

public static final int SCRIPT_VARIABLES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HiveJob getDefaultInstance()
Returns
Type Description
HiveJob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static HiveJob.Builder newBuilder()
Returns
Type Description
HiveJob.Builder

newBuilder(HiveJob prototype)

public static HiveJob.Builder newBuilder(HiveJob prototype)
Parameter
Name Description
prototype HiveJob
Returns
Type Description
HiveJob.Builder

parseDelimitedFrom(InputStream input)

public static HiveJob parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HiveJob
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HiveJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveJob
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HiveJob parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HiveJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HiveJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HiveJob parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HiveJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HiveJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HiveJob parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HiveJob
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HiveJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveJob
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HiveJob parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HiveJob
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HiveJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveJob
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HiveJob parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HiveJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HiveJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveJob
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HiveJob> parser()
Returns
Type Description
Parser<HiveJob>

Methods

containsProperties(String key)

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

Parameter
Name Description
key String
Returns
Type Description
boolean

containsScriptVariables(String key)

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

Returns
Type Description
boolean

The continueOnFailure.

getDefaultInstanceForType()

public HiveJob getDefaultInstanceForType()
Returns
Type Description
HiveJob

getJarFileUris(int index)

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

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The jarFileUris at the given index.

getJarFileUrisBytes(int index)

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

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the jarFileUris at the given index.

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

Returns
Type Description
int

The count of jarFileUris.

getJarFileUrisList()

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

Returns
Type Description
ProtocolStringList

A list containing the jarFileUris.

getParserForType()

public Parser<HiveJob> getParserForType()
Returns
Type Description
Parser<HiveJob>
Overrides

getProperties() (deprecated)

public Map<String,String> getProperties()

Use #getPropertiesMap() instead.

Returns
Type Description
Map<String,String>

getPropertiesCount()

public int getPropertiesCount()

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

Returns
Type Description
int

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

Returns
Type Description
Map<String,String>

getPropertiesOrDefault(String key, String defaultValue)

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getPropertiesOrThrow(String key)

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

Parameter
Name Description
key String
Returns
Type Description
String

getQueriesCase()

public HiveJob.QueriesCase getQueriesCase()
Returns
Type Description
HiveJob.QueriesCase

getQueryFileUri()

public String getQueryFileUri()

The HCFS URI of the script that contains Hive queries.

string query_file_uri = 1;

Returns
Type Description
String

The queryFileUri.

getQueryFileUriBytes()

public ByteString getQueryFileUriBytes()

The HCFS URI of the script that contains Hive queries.

string query_file_uri = 1;

Returns
Type Description
ByteString

The bytes for queryFileUri.

getQueryList()

public QueryList getQueryList()

A list of queries.

.google.cloud.dataproc.v1.QueryList query_list = 2;

Returns
Type Description
QueryList

The queryList.

getQueryListOrBuilder()

public QueryListOrBuilder getQueryListOrBuilder()

A list of queries.

.google.cloud.dataproc.v1.QueryList query_list = 2;

Returns
Type Description
QueryListOrBuilder

getScriptVariables() (deprecated)

public Map<String,String> getScriptVariables()
Returns
Type Description
Map<String,String>

getScriptVariablesCount()

public int getScriptVariablesCount()

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

Returns
Type Description
int

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

Returns
Type Description
Map<String,String>

getScriptVariablesOrDefault(String key, String defaultValue)

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getScriptVariablesOrThrow(String key)

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

Parameter
Name Description
key String
Returns
Type Description
String

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasQueryFileUri()

public boolean hasQueryFileUri()

The HCFS URI of the script that contains Hive queries.

string query_file_uri = 1;

Returns
Type Description
boolean

Whether the queryFileUri field is set.

hasQueryList()

public boolean hasQueryList()

A list of queries.

.google.cloud.dataproc.v1.QueryList query_list = 2;

Returns
Type Description
boolean

Whether the queryList field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HiveJob.Builder newBuilderForType()
Returns
Type Description
HiveJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HiveJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HiveJob.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HiveJob.Builder toBuilder()
Returns
Type Description
HiveJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException