BigQuery Data Transfer Service V1 API - Class Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest (v0.14.2)

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

Returns

(::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 by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL:
```
https://bigquery.cloud.google.com/datatransfer/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

Parameter

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 by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL:
```
https://bigquery.cloud.google.com/datatransfer/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.

Returns

(::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 by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL:
```
https://bigquery.cloud.google.com/datatransfer/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

Returns

(::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

Parameter

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.

Returns

(::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

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. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL:
```
https://bigquery.cloud.google.com/datatransfer/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

Parameter

value (::String) — Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL:
```
https://bigquery.cloud.google.com/datatransfer/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.

Returns

(::String) — Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL:
```
https://bigquery.cloud.google.com/datatransfer/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.