Google Cloud Dataproc V1 Client - Class HiveJob (3.11.0)

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

Namespace

Google \ Cloud \ Dataproc \ V1

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 `false`. Setting to `true` can be useful when executing independent parallel queries.
`↳ script_variables`	`array\|Google\Protobuf\Internal\MapField` Optional. Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
`↳ 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.

Returns
Type	Description
`string`

hasQueryFileUri

setQueryFileUri

The HCFS URI of the script that contains Hive queries.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getQueryList

A list of queries.

Returns
Type	Description
`Google\Cloud\Dataproc\V1\QueryList\|null`

hasQueryList

setQueryList

A list of queries.

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.

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.

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";).

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setScriptVariables

Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

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.

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.

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.

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.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getQueries

Returns
Type	Description
`string`