Class HiveJob.Builder (4.41.0)

public static final class HiveJob.Builder extends GeneratedMessageV3.Builder<HiveJob.Builder> implements HiveJobOrBuilder

A Dataproc job for running Apache Hive queries on YARN.

Protobuf type google.cloud.dataproc.v1.HiveJob

Implements

HiveJobOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllJarFileUris(Iterable<String> values)

public HiveJob.Builder addAllJarFileUris(Iterable<String> values)

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
values Iterable<String>

The jarFileUris to add.

Returns
Type Description
HiveJob.Builder

This builder for chaining.

addJarFileUris(String value)

public HiveJob.Builder addJarFileUris(String value)

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
value String

The jarFileUris to add.

Returns
Type Description
HiveJob.Builder

This builder for chaining.

addJarFileUrisBytes(ByteString value)

public HiveJob.Builder addJarFileUrisBytes(ByteString value)

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
value ByteString

The bytes of the jarFileUris to add.

Returns
Type Description
HiveJob.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HiveJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HiveJob.Builder
Overrides

build()

public HiveJob build()
Returns
Type Description
HiveJob

buildPartial()

public HiveJob buildPartial()
Returns
Type Description
HiveJob

clear()

public HiveJob.Builder clear()
Returns
Type Description
HiveJob.Builder
Overrides

clearContinueOnFailure()

public HiveJob.Builder clearContinueOnFailure()

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
HiveJob.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public HiveJob.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
HiveJob.Builder
Overrides

clearJarFileUris()

public HiveJob.Builder clearJarFileUris()

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
HiveJob.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public HiveJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
HiveJob.Builder
Overrides

clearProperties()

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

clearQueries()

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

clearQueryFileUri()

public HiveJob.Builder clearQueryFileUri()

The HCFS URI of the script that contains Hive queries.

string query_file_uri = 1;

Returns
Type Description
HiveJob.Builder

This builder for chaining.

clearQueryList()

public HiveJob.Builder clearQueryList()

A list of queries.

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

Returns
Type Description
HiveJob.Builder

clearScriptVariables()

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

clone()

public HiveJob.Builder clone()
Returns
Type Description
HiveJob.Builder
Overrides

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getMutableProperties() (deprecated)

public Map<String,String> getMutableProperties()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableScriptVariables() (deprecated)

public Map<String,String> getMutableScriptVariables()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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.

getQueryListBuilder()

public QueryList.Builder getQueryListBuilder()

A list of queries.

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

Returns
Type Description
QueryList.Builder

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

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(HiveJob other)

public HiveJob.Builder mergeFrom(HiveJob other)
Parameter
Name Description
other HiveJob
Returns
Type Description
HiveJob.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HiveJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveJob.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public HiveJob.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
HiveJob.Builder
Overrides

mergeQueryList(QueryList value)

public HiveJob.Builder mergeQueryList(QueryList value)

A list of queries.

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

Parameter
Name Description
value QueryList
Returns
Type Description
HiveJob.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HiveJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HiveJob.Builder
Overrides

putAllProperties(Map<String,String> values)

public HiveJob.Builder putAllProperties(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
HiveJob.Builder

putAllScriptVariables(Map<String,String> values)

public HiveJob.Builder putAllScriptVariables(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
HiveJob.Builder

putProperties(String key, String value)

public HiveJob.Builder putProperties(String key, String value)

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
value String
Returns
Type Description
HiveJob.Builder

putScriptVariables(String key, String value)

public HiveJob.Builder putScriptVariables(String key, String value)

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
value String
Returns
Type Description
HiveJob.Builder

removeProperties(String key)

public HiveJob.Builder removeProperties(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
HiveJob.Builder

removeScriptVariables(String key)

public HiveJob.Builder removeScriptVariables(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
HiveJob.Builder

setContinueOnFailure(boolean value)

public HiveJob.Builder setContinueOnFailure(boolean value)

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

Parameter
Name Description
value boolean

The continueOnFailure to set.

Returns
Type Description
HiveJob.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public HiveJob.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HiveJob.Builder
Overrides

setJarFileUris(int index, String value)

public HiveJob.Builder setJarFileUris(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.

value String

The jarFileUris to set.

Returns
Type Description
HiveJob.Builder

This builder for chaining.

setQueryFileUri(String value)

public HiveJob.Builder setQueryFileUri(String value)

The HCFS URI of the script that contains Hive queries.

string query_file_uri = 1;

Parameter
Name Description
value String

The queryFileUri to set.

Returns
Type Description
HiveJob.Builder

This builder for chaining.

setQueryFileUriBytes(ByteString value)

public HiveJob.Builder setQueryFileUriBytes(ByteString value)

The HCFS URI of the script that contains Hive queries.

string query_file_uri = 1;

Parameter
Name Description
value ByteString

The bytes for queryFileUri to set.

Returns
Type Description
HiveJob.Builder

This builder for chaining.

setQueryList(QueryList value)

public HiveJob.Builder setQueryList(QueryList value)

A list of queries.

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

Parameter
Name Description
value QueryList
Returns
Type Description
HiveJob.Builder

setQueryList(QueryList.Builder builderForValue)

public HiveJob.Builder setQueryList(QueryList.Builder builderForValue)

A list of queries.

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

Parameter
Name Description
builderForValue QueryList.Builder
Returns
Type Description
HiveJob.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public HiveJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
HiveJob.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final HiveJob.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HiveJob.Builder
Overrides