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, authorization info needs to be provided.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#authorization_code
def authorization_code() -> ::String
-
(::String) — Optional OAuth2 authorization code to use with this transfer configuration.
This is required only if
transferConfig.dataSourceId
is 'youtube_channel' and new credentials are needed, as indicated byCheckValidCreds
. In order to obtain authorization_code, make a request to the following URL:https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
- The client_id is the OAuth client_id of the a data source as returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
Note that this should not be set when
service_account_name
is used to update the transfer config.
#authorization_code=
def authorization_code=(value) -> ::String
-
value (::String) — Optional OAuth2 authorization code to use with this transfer configuration.
This is required only if
transferConfig.dataSourceId
is 'youtube_channel' and new credentials are needed, as indicated byCheckValidCreds
. In order to obtain authorization_code, make a request to the following URL:https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
- The client_id is the OAuth client_id of the a data source as returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
Note that this should not be set when
service_account_name
is used to update the transfer config.
-
(::String) — Optional OAuth2 authorization code to use with this transfer configuration.
This is required only if
transferConfig.dataSourceId
is 'youtube_channel' and new credentials are needed, as indicated byCheckValidCreds
. In order to obtain authorization_code, make a request to the following URL:https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
- The client_id is the OAuth client_id of the a data source as returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
Note that this should not be set when
service_account_name
is used to update the transfer config.
#service_account_name
def service_account_name() -> ::String
-
(::String) — Optional service account email. If this field is set, the transfer config
will be created with this service account's credentials. It requires that
the requesting user calling this API has permissions to act as this service
account.
Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.
#service_account_name=
def service_account_name=(value) -> ::String
-
value (::String) — Optional service account email. If this field is set, the transfer config
will be created with this service account's credentials. It requires that
the requesting user calling this API has permissions to act as this service
account.
Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.
-
(::String) — Optional service account email. If this field is set, the transfer config
will be created with this service account's credentials. It requires that
the requesting user calling this API has permissions to act as this service
account.
Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.
#transfer_config
def transfer_config() -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
- (::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig) — Required. Data transfer configuration to create.
#transfer_config=
def transfer_config=(value) -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
- value (::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig) — Required. Data transfer configuration to create.
- (::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig) — Required. Data transfer configuration to create.
#update_mask
def update_mask() -> ::Google::Protobuf::FieldMask
- (::Google::Protobuf::FieldMask) — Required. Required list of fields to be updated in this request.
#update_mask=
def update_mask=(value) -> ::Google::Protobuf::FieldMask
- value (::Google::Protobuf::FieldMask) — Required. Required list of fields to be updated in this request.
- (::Google::Protobuf::FieldMask) — Required. Required list of fields to be updated in this request.
#version_info
def version_info() -> ::String
-
(::String) — Optional version info. This is required only if
transferConfig.dataSourceId
is not 'youtube_channel' and new credentials are needed, as indicated byCheckValidCreds
. In order to obtain version info, make a request to the following URL:https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
- The client_id is the OAuth client_id of the a data source as returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
Note that this should not be set when
service_account_name
is used to update the transfer config.
#version_info=
def version_info=(value) -> ::String
-
value (::String) — Optional version info. This is required only if
transferConfig.dataSourceId
is not 'youtube_channel' and new credentials are needed, as indicated byCheckValidCreds
. In order to obtain version info, make a request to the following URL:https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
- The client_id is the OAuth client_id of the a data source as returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
Note that this should not be set when
service_account_name
is used to update the transfer config.
-
(::String) — Optional version info. This is required only if
transferConfig.dataSourceId
is not 'youtube_channel' and new credentials are needed, as indicated byCheckValidCreds
. In order to obtain version info, make a request to the following URL:https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
- The client_id is the OAuth client_id of the a data source as returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
Note that this should not be set when
service_account_name
is used to update the transfer config.