Class: Google::Cloud::Bigquery::Datatransfer::V1::CreateTransferConfigRequest
- Inherits:
-
Object
- Object
- Google::Cloud::Bigquery::Datatransfer::V1::CreateTransferConfigRequest
- Defined in:
- lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb
Overview
A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, an authorization code must be provided. If an authorization code is provided, the transfer configuration will be associated with the user id corresponding to the authorization code. Otherwise, the transfer configuration will be associated with the calling user.
Instance Attribute Summary collapse
-
#authorization_code ⇒ String
Optional OAuth2 authorization code to use with this transfer configuration.
-
#parent ⇒ String
Required.
-
#service_account_name ⇒ String
Optional service account name.
-
#transfer_config ⇒ Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig
Required.
-
#version_info ⇒ String
Optional version info.
Instance Attribute Details
#authorization_code ⇒ String
Optional OAuth2 authorization code to use with this transfer configuration.
This is required if new credentials are needed, as indicated by
CheckValidCreds
.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=
- client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
- redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
291 |
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 291 class CreateTransferConfigRequest; end |
#parent ⇒ String
Returns Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.
291 |
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 291 class CreateTransferConfigRequest; end |
#service_account_name ⇒ String
Returns Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
291 |
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 291 class CreateTransferConfigRequest; end |
#transfer_config ⇒ Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig
Returns Required. Data transfer configuration to create.
291 |
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 291 class CreateTransferConfigRequest; end |
#version_info ⇒ String
Returns Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
291 |
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 291 class CreateTransferConfigRequest; end |