Class HiveJob.Builder (4.8.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
TypeDescription
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
NameDescription
valuesIterable<String>

The jarFileUris to add.

Returns
TypeDescription
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
NameDescription
valueString

The jarFileUris to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the jarFileUris to add.

Returns
TypeDescription
HiveJob.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HiveJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
HiveJob.Builder
Overrides

build()

public HiveJob build()
Returns
TypeDescription
HiveJob

buildPartial()

public HiveJob buildPartial()
Returns
TypeDescription
HiveJob

clear()

public HiveJob.Builder clear()
Returns
TypeDescription
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
TypeDescription
HiveJob.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public HiveJob.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
HiveJob.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public HiveJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
HiveJob.Builder
Overrides

clearProperties()

public HiveJob.Builder clearProperties()
Returns
TypeDescription
HiveJob.Builder

clearQueries()

public HiveJob.Builder clearQueries()
Returns
TypeDescription
HiveJob.Builder

clearQueryFileUri()

public HiveJob.Builder clearQueryFileUri()

The HCFS URI of the script that contains Hive queries.

string query_file_uri = 1;

Returns
TypeDescription
HiveJob.Builder

This builder for chaining.

clearQueryList()

public HiveJob.Builder clearQueryList()

A list of queries.

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

Returns
TypeDescription
HiveJob.Builder

clearScriptVariables()

public HiveJob.Builder clearScriptVariables()
Returns
TypeDescription
HiveJob.Builder

clone()

public HiveJob.Builder clone()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
boolean

The continueOnFailure.

getDefaultInstanceForType()

public HiveJob getDefaultInstanceForType()
Returns
TypeDescription
HiveJob

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the jarFileUris.

getMutableProperties()

public Map<String,String> getMutableProperties()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getMutableScriptVariables()

public Map<String,String> getMutableScriptVariables()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getProperties()

public Map<String,String> getProperties()

Use #getPropertiesMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getQueriesCase()

public HiveJob.QueriesCase getQueriesCase()
Returns
TypeDescription
HiveJob.QueriesCase

getQueryFileUri()

public String getQueryFileUri()

The HCFS URI of the script that contains Hive queries.

string query_file_uri = 1;

Returns
TypeDescription
String

The queryFileUri.

getQueryFileUriBytes()

public ByteString getQueryFileUriBytes()

The HCFS URI of the script that contains Hive queries.

string query_file_uri = 1;

Returns
TypeDescription
ByteString

The bytes for queryFileUri.

getQueryList()

public QueryList getQueryList()

A list of queries.

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

Returns
TypeDescription
QueryList

The queryList.

getQueryListBuilder()

public QueryList.Builder getQueryListBuilder()

A list of queries.

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

Returns
TypeDescription
QueryList.Builder

getQueryListOrBuilder()

public QueryListOrBuilder getQueryListOrBuilder()

A list of queries.

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

Returns
TypeDescription
QueryListOrBuilder

getScriptVariables()

public Map<String,String> getScriptVariables()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

hasQueryFileUri()

public boolean hasQueryFileUri()

The HCFS URI of the script that contains Hive queries.

string query_file_uri = 1;

Returns
TypeDescription
boolean

Whether the queryFileUri field is set.

hasQueryList()

public boolean hasQueryList()

A list of queries.

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

Returns
TypeDescription
boolean

Whether the queryList field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(HiveJob other)

public HiveJob.Builder mergeFrom(HiveJob other)
Parameter
NameDescription
otherHiveJob
Returns
TypeDescription
HiveJob.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HiveJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HiveJob.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public HiveJob.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueQueryList
Returns
TypeDescription
HiveJob.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HiveJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
valueboolean

The continueOnFailure to set.

Returns
TypeDescription
HiveJob.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public HiveJob.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The jarFileUris to set.

Returns
TypeDescription
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
NameDescription
valueString

The queryFileUri to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for queryFileUri to set.

Returns
TypeDescription
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
NameDescription
valueQueryList
Returns
TypeDescription
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
NameDescription
builderForValueQueryList.Builder
Returns
TypeDescription
HiveJob.Builder

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

public HiveJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
HiveJob.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final HiveJob.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
HiveJob.Builder
Overrides