Reference documentation and code samples for the BigQuery Data Transfer Service V1 API class Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest.
A request to update a transfer configuration. To update the user id of the transfer configuration, an authorization code needs to be provided.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#authorization_code
def authorization_code() -> ::String
Returns
-
(::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.
#authorization_code=
def authorization_code=(value) -> ::String
Parameter
-
value (::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.
Returns
-
(::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.
#service_account_name
def service_account_name() -> ::String
Returns
- (::String) — 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.
#service_account_name=
def service_account_name=(value) -> ::String
Parameter
- value (::String) — 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.
Returns
- (::String) — 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.
#transfer_config
def transfer_config() -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
Returns
- (::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig) — Required. Data transfer configuration to create.
#transfer_config=
def transfer_config=(value) -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
Parameter
- value (::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig) — Required. Data transfer configuration to create.
Returns
- (::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig) — Required. Data transfer configuration to create.
#update_mask
def update_mask() -> ::Google::Protobuf::FieldMask
Returns
- (::Google::Protobuf::FieldMask) — Required. Required list of fields to be updated in this request.
#update_mask=
def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
- value (::Google::Protobuf::FieldMask) — Required. Required list of fields to be updated in this request.
Returns
- (::Google::Protobuf::FieldMask) — Required. Required list of fields to be updated in this request.
#version_info
def version_info() -> ::String
Returns
- (::String) — 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.
#version_info=
def version_info=(value) -> ::String
Parameter
- value (::String) — 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.
Returns
- (::String) — 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.