Class: Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest
- Inherits:
-
Object
- Object
- Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb
Overview
A request to update a transfer configuration. To update the user id of the transfer configuration, an authorization code needs to be provided.
Instance Attribute Summary collapse
-
#authorization_code ⇒ ::String
Optional OAuth2 authorization code to use with this transfer configuration.
-
#service_account_name ⇒ ::String
Optional service account name.
-
#transfer_config ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
Required.
-
#update_mask ⇒ ::Google::Protobuf::FieldMask
Required.
-
#version_info ⇒ ::String
Optional version info.
Instance Attribute Details
#authorization_code ⇒ ::String
Optional OAuth2 authorization code to use with this transfer configuration.
If it is provided, the transfer configuration will be associated with the
authorizing user.
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.
361 362 363 364 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 361 class UpdateTransferConfigRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#service_account_name ⇒ ::String
Returns Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
361 362 363 364 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 361 class UpdateTransferConfigRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#transfer_config ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
Returns Required. Data transfer configuration to create.
361 362 363 364 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 361 class UpdateTransferConfigRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#update_mask ⇒ ::Google::Protobuf::FieldMask
Returns Required. Required list of fields to be updated in this request.
361 362 363 364 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 361 class UpdateTransferConfigRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods 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.
361 362 363 364 |
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 361 class UpdateTransferConfigRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |