Reference documentation and code samples for the BigQuery Data Transfer V1 Client class StartBigQueryJobsRequest.
A request to start and monitor a BigQuery load job.
Generated from protobuf message google.cloud.bigquery.datatransfer.v1.StartBigQueryJobsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}" |
↳ imported_data |
array<Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo>
Import jobs which should be started and monitored. |
↳ user_credentials |
string
User credentials which should be used to start/monitor BigQuery jobs. If not specified, then jobs are started using data source service account credentials. This may be OAuth token or JWT token. |
↳ max_parallelism |
int
The number of BQ Jobs that can run in parallel. |
getName
Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
Generated from protobuf field string name = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getImportedData
Import jobs which should be started and monitored.
Generated from protobuf field repeated .google.cloud.bigquery.datatransfer.v1.ImportedDataInfo imported_data = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setImportedData
Import jobs which should be started and monitored.
Generated from protobuf field repeated .google.cloud.bigquery.datatransfer.v1.ImportedDataInfo imported_data = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BigQuery\DataTransfer\V1\ImportedDataInfo>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUserCredentials
User credentials which should be used to start/monitor BigQuery jobs. If not specified, then jobs are started using data source service account credentials.
This may be OAuth token or JWT token.
Generated from protobuf field bytes user_credentials = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setUserCredentials
User credentials which should be used to start/monitor BigQuery jobs. If not specified, then jobs are started using data source service account credentials.
This may be OAuth token or JWT token.
Generated from protobuf field bytes user_credentials = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxParallelism
The number of BQ Jobs that can run in parallel.
Generated from protobuf field int32 max_parallelism = 8;
| Returns | |
|---|---|
| Type | Description |
int | |
setMaxParallelism
The number of BQ Jobs that can run in parallel.
Generated from protobuf field int32 max_parallelism = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |