Class: Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest

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 update a transfer configuration. To update the user id of the transfer configuration, authorization info needs to be provided.

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 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://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 update the transfer config.



380
381
382
383
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 380

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



380
381
382
383
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 380

class UpdateTransferConfigRequest
  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:



380
381
382
383
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 380

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

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns Required. Required list of fields to be updated in this request.

Returns:



380
381
382
383
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 380

class UpdateTransferConfigRequest
  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 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://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 update the transfer config.



380
381
382
383
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 380

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