Class: Google::Cloud::Bigquery::DataTransfer::V1::CreateTransferConfigRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/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, authorization info must be provided. If authorization info is provided, the transfer configuration will be associated with the user id corresponding to the authorization info. Otherwise, the transfer configuration will be associated with the calling user.

Instance Attribute Summary collapse

Instance Attribute Details

#authorization_code ⇒ ::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://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
  • 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 create 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://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
    • 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 create the transfer config.



324
325
326
327
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 324

class CreateTransferConfigRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.

Returns:

  • (::String) —

    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.



324
325
326
327
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 324

class CreateTransferConfigRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#service_account_name ⇒ ::String

Returns 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.



324
325
326
327
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 324

class CreateTransferConfigRequest
  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.

Returns:



324
325
326
327
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 324

class CreateTransferConfigRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#version_info ⇒ ::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://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
  • 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 create 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://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
    • 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 create the transfer config.



324
325
326
327
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 324

class CreateTransferConfigRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end