Reference documentation and code samples for the Google Cloud Dataproc V1 Client class HiveJob.
A Dataproc job for running Apache Hive queries on YARN.
Generated from protobuf message google.cloud.dataproc.v1.HiveJob
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ query_file_uri |
string
The HCFS URI of the script that contains Hive queries. |
↳ query_list |
Google\Cloud\Dataproc\V1\QueryList
A list of queries. |
↳ continue_on_failure |
bool
Optional. Whether to continue executing queries if a query fails. The default value is |
↳ script_variables |
array|Google\Protobuf\Internal\MapField
Optional. Mapping of query variable names to values (equivalent to the Hive command: |
↳ properties |
array|Google\Protobuf\Internal\MapField
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. |
↳ jar_file_uris |
array
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. |
getQueryFileUri
The HCFS URI of the script that contains Hive queries.
Generated from protobuf field string query_file_uri = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
hasQueryFileUri
setQueryFileUri
The HCFS URI of the script that contains Hive queries.
Generated from protobuf field string query_file_uri = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryList
A list of queries.
Generated from protobuf field .google.cloud.dataproc.v1.QueryList query_list = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataproc\V1\QueryList|null | |
hasQueryList
setQueryList
A list of queries.
Generated from protobuf field .google.cloud.dataproc.v1.QueryList query_list = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataproc\V1\QueryList
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
Generated from protobuf field bool continue_on_failure = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
bool | |
setContinueOnFailure
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.
Generated from protobuf field bool continue_on_failure = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getScriptVariables
Optional. Mapping of query variable names to values (equivalent to the
Hive command: SET name="value";).
Generated from protobuf field map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setScriptVariables
Optional. Mapping of query variable names to values (equivalent to the
Hive command: SET name="value";).
Generated from protobuf field map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProperties
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.
Generated from protobuf field map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setProperties
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.
Generated from protobuf field map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getJarFileUris
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.
Generated from protobuf field repeated string jar_file_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setJarFileUris
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.
Generated from protobuf field repeated string jar_file_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueries
| Returns | |
|---|---|
| Type | Description |
string | |