Google Cloud Dataproc V1 Client - Class SparkSqlJob (3.2.2)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class SparkSqlJob.

A Dataproc job for running Apache Spark SQL queries.

Generated from protobuf message google.cloud.dataproc.v1.SparkSqlJob

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ query_file_uri string

The HCFS URI of the script that contains SQL queries.

↳ query_list Google\Cloud\Dataproc\V1\QueryList

A list of queries.

↳ script_variables array|Google\Protobuf\Internal\MapField

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

↳ properties array|Google\Protobuf\Internal\MapField

Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

↳ jar_file_uris array

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

↳ logging_config Google\Cloud\Dataproc\V1\LoggingConfig

Optional. The runtime log config for job execution.

getQueryFileUri

The HCFS URI of the script that contains SQL queries.

Generated from protobuf field string query_file_uri = 1;

Returns
TypeDescription
string

hasQueryFileUri

setQueryFileUri

The HCFS URI of the script that contains SQL queries.

Generated from protobuf field string query_file_uri = 1;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getQueryList

A list of queries.

Generated from protobuf field .google.cloud.dataproc.v1.QueryList query_list = 2;

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Dataproc\V1\QueryList
Returns
TypeDescription
$this

getScriptVariables

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

Generated from protobuf field map<string, string> script_variables = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setScriptVariables

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

Generated from protobuf field map<string, string> script_variables = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getProperties

Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

Generated from protobuf field map<string, string> properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setProperties

Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

Generated from protobuf field map<string, string> properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getJarFileUris

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

Generated from protobuf field repeated string jar_file_uris = 56 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setJarFileUris

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

Generated from protobuf field repeated string jar_file_uris = 56 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getLoggingConfig

Optional. The runtime log config for job execution.

Generated from protobuf field .google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Cloud\Dataproc\V1\LoggingConfig|null

hasLoggingConfig

clearLoggingConfig

setLoggingConfig

Optional. The runtime log config for job execution.

Generated from protobuf field .google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var Google\Cloud\Dataproc\V1\LoggingConfig
Returns
TypeDescription
$this

getQueries

Returns
TypeDescription
string