Reference documentation and code samples for the Google Cloud Dataproc V1 Client class PrestoJob.
A Dataproc job for running Presto queries.
IMPORTANT: The Dataproc Presto Optional Component must be enabled when the cluster is created to submit a Presto job to the cluster.
Generated from protobuf message google.cloud.dataproc.v1.PrestoJob
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 SQL 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 |
↳ output_format |
string
Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats |
↳ client_tags |
array
Optional. Presto client tags to attach to this query |
↳ properties |
array|Google\Protobuf\Internal\MapField
Optional. A mapping of property names to values. Used to set Presto session properties Equivalent to using the --session flag in the Presto CLI |
↳ 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 | |
|---|---|
| Type | Description |
string | |
hasQueryFileUri
setQueryFileUri
The HCFS URI of the script that contains SQL 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 | |
getOutputFormat
Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
Generated from protobuf field string output_format = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setOutputFormat
Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
Generated from protobuf field string output_format = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getClientTags
Optional. Presto client tags to attach to this query
Generated from protobuf field repeated string client_tags = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setClientTags
Optional. Presto client tags to attach to this query
Generated from protobuf field repeated string client_tags = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProperties
Optional. A mapping of property names to values. Used to set Presto session properties Equivalent to using the --session flag in the Presto CLI
Generated from protobuf field map<string, string> properties = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setProperties
Optional. A mapping of property names to values. Used to set Presto session properties Equivalent to using the --session flag in the Presto CLI
Generated from protobuf field map<string, string> properties = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLoggingConfig
Optional. The runtime log config for job execution.
Generated from protobuf field .google.cloud.dataproc.v1.LoggingConfig logging_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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 = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataproc\V1\LoggingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueries
| Returns | |
|---|---|
| Type | Description |
string | |