On January 1, 2020 this library will no longer support Python 2 on the latest released version. Previously released library versions will continue to be available. For more information please visit Python 2 support on Google Cloud.

Client for BigQuery Data Transfer API

class google.cloud.bigquery_datatransfer_v1.DataTransferServiceClient(transport=None, channel=None, credentials=None, client_config=None, client_info=None, client_options=None)[source]

The Google BigQuery Data Transfer Service API enables BigQuery users to configure the transfer of their data from other Google Products into BigQuery. This service contains methods that are end user exposed. It backs up the frontend.

Constructor.

Parameters
  • (Union[DataTransferServiceGrpcTransport, (transport) – Callable[[~.Credentials, type], ~.DataTransferServiceGrpcTransport]): A transport instance, responsible for actually making the API calls. The default transport uses the gRPC protocol. This argument may also be a callable which returns a transport instance. Callables will be sent the credentials as the first argument and the default transport class as the second argument.

  • channel (grpc.Channel) – DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.

  • credentials (google.auth.credentials.Credentials) – The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.

  • client_config (dict) – DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

  • client_options (Union[dict, google.api_core.client_options.ClientOptions]) – Client options used to set user options on the client. API Endpoint should be set through client_options.

check_valid_creds(name, retry=<object object>, timeout=<object object>, metadata=None)[source]

Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn’t support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> name = client.project_data_source_path('[PROJECT]', '[DATA_SOURCE]')
>>>
>>> response = client.check_valid_creds(name)
Parameters
  • name (str) – Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A CheckValidCredsResponse instance.

Raises
create_transfer_config(parent, transfer_config, authorization_code=None, version_info=None, service_account_name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

Creates a new data transfer configuration.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> parent = client.project_path('[PROJECT]')
>>>
>>> # TODO: Initialize `transfer_config`:
>>> transfer_config = {}
>>>
>>> response = client.create_transfer_config(parent, transfer_config)
Parameters
  • parent (str) – 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.

  • transfer_config (Union[dict, TransferConfig]) –

    Required. Data transfer configuration to create.

    If a dict is provided, it must be of the same form as the protobuf message TransferConfig

  • authorization_code (str) –

    Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=<data_source_scopes>&redirect_uri=<redirect_uri>

    • client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.

    • data_source_scopes are the scopes returned by ListDataSources method.

    • redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

  • version_info (str) – Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

  • service_account_name (str) – Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A TransferConfig instance.

Raises
delete_transfer_config(name, retry=<object object>, timeout=<object object>, metadata=None)[source]

Deletes a data transfer configuration, including any associated transfer runs and logs.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> name = client.project_transfer_config_path('[PROJECT]', '[TRANSFER_CONFIG]')
>>>
>>> client.delete_transfer_config(name)
Parameters
  • name (str) – Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Raises
delete_transfer_run(name, retry=<object object>, timeout=<object object>, metadata=None)[source]

Deletes the specified transfer run.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> name = client.project_run_path('[PROJECT]', '[TRANSFER_CONFIG]', '[RUN]')
>>>
>>> client.delete_transfer_run(name)
Parameters
  • name (str) – Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Raises
enums = <module 'google.cloud.bigquery_datatransfer_v1.gapic.enums' from '/tmpfs/src/github/python-bigquery-datatransfer/google/cloud/bigquery_datatransfer_v1/gapic/enums.py'>
classmethod from_service_account_file(filename, *args, **kwargs)[source]

Creates an instance of this client using the provided credentials file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DataTransferServiceClient

classmethod from_service_account_json(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DataTransferServiceClient

get_data_source(name, retry=<object object>, timeout=<object object>, metadata=None)[source]

Retrieves a supported data source and returns its settings, which can be used for UI rendering.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> name = client.project_data_source_path('[PROJECT]', '[DATA_SOURCE]')
>>>
>>> response = client.get_data_source(name)
Parameters
  • name (str) – Required. The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A DataSource instance.

Raises
get_transfer_config(name, retry=<object object>, timeout=<object object>, metadata=None)[source]

Returns information about a data transfer config.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> name = client.project_transfer_config_path('[PROJECT]', '[TRANSFER_CONFIG]')
>>>
>>> response = client.get_transfer_config(name)
Parameters
  • name (str) – Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A TransferConfig instance.

Raises
get_transfer_run(name, retry=<object object>, timeout=<object object>, metadata=None)[source]

Returns information about the particular transfer run.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> name = client.project_run_path('[PROJECT]', '[TRANSFER_CONFIG]', '[RUN]')
>>>
>>> response = client.get_transfer_run(name)
Parameters
  • name (str) – Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A TransferRun instance.

Raises
list_data_sources(parent, page_size=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

Lists supported data sources and returns their settings, which can be used for UI rendering.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> parent = client.project_path('[PROJECT]')
>>>
>>> # Iterate over all results
>>> for element in client.list_data_sources(parent):
...     # process element
...     pass
>>>
>>>
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_data_sources(parent).pages:
...     for element in page:
...         # process element
...         pass
Parameters
  • parent (str) – Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id} or `projects/{project_id}/locations/{location_id}

  • page_size (int) – The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A PageIterator instance. An iterable of DataSource instances. You can also iterate over the pages of the response using its pages property.

Raises
list_transfer_configs(parent, data_source_ids=None, page_size=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

Returns information about all data transfers in the project.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> parent = client.project_path('[PROJECT]')
>>>
>>> # Iterate over all results
>>> for element in client.list_transfer_configs(parent):
...     # process element
...     pass
>>>
>>>
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_transfer_configs(parent).pages:
...     for element in page:
...         # process element
...         pass
Parameters
  • parent (str) – Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

  • data_source_ids (list[str]) – When specified, only configurations of requested data sources are returned.

  • page_size (int) – The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A PageIterator instance. An iterable of TransferConfig instances. You can also iterate over the pages of the response using its pages property.

Raises
list_transfer_logs(parent, page_size=None, message_types=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

Returns user facing log messages for the data transfer run.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> parent = client.project_run_path('[PROJECT]', '[TRANSFER_CONFIG]', '[RUN]')
>>>
>>> # Iterate over all results
>>> for element in client.list_transfer_logs(parent):
...     # process element
...     pass
>>>
>>>
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_transfer_logs(parent).pages:
...     for element in page:
...         # process element
...         pass
Parameters
  • parent (str) – Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

  • page_size (int) – The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • message_types (list[MessageSeverity]) – Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A PageIterator instance. An iterable of TransferMessage instances. You can also iterate over the pages of the response using its pages property.

Raises
list_transfer_runs(parent, states=None, page_size=None, run_attempt=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

Returns information about running and completed jobs.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> parent = client.project_transfer_config_path('[PROJECT]', '[TRANSFER_CONFIG]')
>>>
>>> # Iterate over all results
>>> for element in client.list_transfer_runs(parent):
...     # process element
...     pass
>>>
>>>
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_transfer_runs(parent).pages:
...     for element in page:
...         # process element
...         pass
Parameters
  • parent (str) – Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

  • states (list[TransferState]) – When specified, only transfer runs with requested states are returned.

  • page_size (int) – The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • run_attempt (RunAttempt) – Indicates how run attempts are to be pulled.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A PageIterator instance. An iterable of TransferRun instances. You can also iterate over the pages of the response using its pages property.

Raises
classmethod location_data_source_path(project, location, data_source)[source]

Return a fully-qualified location_data_source string.

classmethod location_path(project, location)[source]

Return a fully-qualified location string.

classmethod location_run_path(project, location, transfer_config, run)[source]

Return a fully-qualified location_run string.

classmethod location_transfer_config_path(project, location, transfer_config)[source]

Return a fully-qualified location_transfer_config string.

classmethod project_data_source_path(project, data_source)[source]

Return a fully-qualified project_data_source string.

classmethod project_path(project)[source]

Return a fully-qualified project string.

classmethod project_run_path(project, transfer_config, run)[source]

Return a fully-qualified project_run string.

classmethod project_transfer_config_path(project, transfer_config)[source]

Return a fully-qualified project_transfer_config string.

schedule_transfer_runs(parent, start_time, end_time, retry=<object object>, timeout=<object object>, metadata=None)[source]

Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> parent = client.project_transfer_config_path('[PROJECT]', '[TRANSFER_CONFIG]')
>>>
>>> # TODO: Initialize `start_time`:
>>> start_time = {}
>>>
>>> # TODO: Initialize `end_time`:
>>> end_time = {}
>>>
>>> response = client.schedule_transfer_runs(parent, start_time, end_time)
Parameters
  • parent (str) – Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

  • start_time (Union[dict, Timestamp]) –

    Required. Start time of the range of transfer runs. For example, "2017-05-25T00:00:00+00:00".

    If a dict is provided, it must be of the same form as the protobuf message Timestamp

  • end_time (Union[dict, Timestamp]) –

    Required. End time of the range of transfer runs. For example, "2017-05-30T00:00:00+00:00".

    If a dict is provided, it must be of the same form as the protobuf message Timestamp

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A ScheduleTransferRunsResponse instance.

Raises
start_manual_transfer_runs(parent=None, requested_time_range=None, requested_run_time=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> response = client.start_manual_transfer_runs()
Parameters
  • parent (str) – Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

  • requested_time_range (Union[dict, TimeRange]) –

    Time range for the transfer runs that should be started.

    If a dict is provided, it must be of the same form as the protobuf message TimeRange

  • requested_run_time (Union[dict, Timestamp]) –

    Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.

    If a dict is provided, it must be of the same form as the protobuf message Timestamp

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A StartManualTransferRunsResponse instance.

Raises
update_transfer_config(transfer_config, update_mask, authorization_code=None, version_info=None, service_account_name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

Updates a data transfer configuration. All fields must be set, even if they are not updated.

Example

>>> from google.cloud import bigquery_datatransfer_v1
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> # TODO: Initialize `transfer_config`:
>>> transfer_config = {}
>>>
>>> # TODO: Initialize `update_mask`:
>>> update_mask = {}
>>>
>>> response = client.update_transfer_config(transfer_config, update_mask)
Parameters
  • transfer_config (Union[dict, TransferConfig]) –

    Required. Data transfer configuration to create.

    If a dict is provided, it must be of the same form as the protobuf message TransferConfig

  • update_mask (Union[dict, FieldMask]) –

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

    If a dict is provided, it must be of the same form as the protobuf message FieldMask

  • authorization_code (str) –

    Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=<data_source_scopes>&redirect_uri=<redirect_uri>

    • client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.

    • data_source_scopes are the scopes returned by ListDataSources method.

    • redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

  • version_info (str) – Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

  • service_account_name (str) – Optional service account name. If this field is set and “service_account_name” is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A TransferConfig instance.

Raises