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.

When using a cross project service account for creating a transfer config, you must enable cross project service account usage. For more information, see Disable attachment of service accounts to resources in other projects.

Instance Attribute Summary collapse

Instance Attribute Details

#authorization_code ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Deprecated: Authorization code was required when transferConfig.dataSourceId is 'youtube_channel' but it is no longer used in any data sources. Use version_info instead.

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=<var>client_id</var>&scope=<var>data_source_scopes</var>
  • The client_id is the OAuth client_id of the 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) —

    Deprecated: Authorization code was required when transferConfig.dataSourceId is 'youtube_channel' but it is no longer used in any data sources. Use version_info instead.

    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=<var>client_id</var>&scope=<var>data_source_scopes</var>
    • The client_id is the OAuth client_id of the 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.



335
336
337
338
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 335

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.



335
336
337
338
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 335

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.



335
336
337
338
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 335

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:



335
336
337
338
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 335

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

#version_info ⇒ ::String

Optional version info. This parameter replaces authorization_code which is no longer used in any data sources. This is required only if transferConfig.dataSourceId is 'youtube_channel' or 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=<var>client_id</var>&scope=<var>data_source_scopes</var>
  • The client_id is the OAuth client_id of the 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 parameter replaces authorization_code which is no longer used in any data sources. This is required only if transferConfig.dataSourceId is 'youtube_channel' or 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=<var>client_id</var>&scope=<var>data_source_scopes</var>
    • The client_id is the OAuth client_id of the 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.



335
336
337
338
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 335

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