google_api_big_query_data_transfer v0.8.0 GoogleApi.BigQueryDataTransfer.V1.Api.Projects View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

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.

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

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

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.

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

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

Lists information about the supported locations for this service.

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

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

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.

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.

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

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

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.

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.

Link to this section Functions

Link to this function

bigquerydatatransfer_projects_data_sources_check_valid_creds(connection, name, optional_params \\ [], opts \\ []) View 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.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The data source in the form: projects/{project_id}/dataSources/{data_source_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.BigQueryDataTransfer.V1.Model.CheckValidCredsRequest.t):

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.CheckValidCredsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_data_sources_get(connection, name, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.DataSource{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_data_sources_list(connection, parent, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (integer()): Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (String.t): Pagination token, which can be used to request a specific page

of ListDataSourcesRequest list results. For multiple-page results, ListDataSourcesResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ListDataSourcesResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_data_sources_check_valid_creds(connection, name, optional_params \\ [], opts \\ []) View 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.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The data source in the form: projects/{project_id}/dataSources/{data_source_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.BigQueryDataTransfer.V1.Model.CheckValidCredsRequest.t):

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.CheckValidCredsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_data_sources_get(connection, name, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.DataSource{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_data_sources_list(connection, parent, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (integer()): Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (String.t): Pagination token, which can be used to request a specific page

of ListDataSourcesRequest list results. For multiple-page results, ListDataSourcesResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ListDataSourcesResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_get(connection, name, optional_params \\ [], opts \\ []) View Source

Gets information about a location.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): Resource name for the location.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.Location{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_list(connection, name, optional_params \\ [], opts \\ []) View Source

Lists information about the supported locations for this service.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The resource that owns the locations collection, if applicable.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :filter (String.t): The standard list filter.
    • :pageSize (integer()): The standard list page size.
    • :pageToken (String.t): The standard list page token.

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ListLocationsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_transfer_configs_create(connection, parent, optional_params \\ [], opts \\ []) View Source

Creates a new data transfer configuration.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :authorizationCode (String.t): 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=&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.

    • :versionInfo (String.t): 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.

  • :body (GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t):

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_transfer_configs_delete(connection, name, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_transfer_configs_get(connection, name, optional_params \\ [], opts \\ []) View Source

Returns information about a data transfer config.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_transfer_configs_list(connection, parent, optional_params \\ [], opts \\ []) View Source

Returns information about all data transfers in the project.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): The BigQuery project id for which data sources should be returned: projects/{project_id}.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :dataSourceIds (list(String.t)): When specified, only configurations of requested data sources are returned.
    • :pageSize (integer()): Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (String.t): Pagination token, which can be used to request a specific page

of ListTransfersRequest list results. For multiple-page results, ListTransfersResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferConfigsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_transfer_configs_patch(connection, name, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The resource name of the transfer config. Transfer config names have the form of projects/{project_id}/locations/{region}/transferConfigs/{config_id}. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :authorizationCode (String.t): 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=&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.

    • :updateMask (String.t): Required list of fields to be updated in this request.
    • :versionInfo (String.t): 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.

  • :body (GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t):

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_transfer_configs_runs_delete(connection, name, optional_params \\ [], opts \\ []) View Source

Deletes the specified transfer run.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_transfer_configs_runs_get(connection, name, optional_params \\ [], opts \\ []) View Source

Returns information about the particular transfer run.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferRun{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_transfer_configs_runs_list(connection, parent, optional_params \\ [], opts \\ []) View Source

Returns information about running and completed jobs.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id}.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (integer()): Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (String.t): Pagination token, which can be used to request a specific page

of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

  • :runAttempt (String.t): Indicates how run attempts are to be pulled.
  • :states (list(String.t)): When specified, only transfer runs with requested states are returned.

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferRunsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_transfer_configs_runs_transfer_logs_list(connection, parent, optional_params \\ [], opts \\ []) View Source

Returns user facing log messages for the data transfer run.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): Transfer run name in the form: projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :messageTypes (list(String.t)): Message types to return. If not populated - INFO, WARNING and ERROR

messages are returned.

  • :pageSize (integer()): Page size. The default page size is the maximum value of 1000 results.
  • :pageToken (String.t): Pagination token, which can be used to request a specific page of ListTransferLogsRequest list results. For multiple-page results, ListTransferLogsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferLogsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_transfer_configs_schedule_runs(connection, parent, optional_params \\ [], opts \\ []) View 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.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id}.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleTransferRunsRequest.t):

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleTransferRunsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_locations_transfer_configs_start_manual_runs(connection, parent, optional_params \\ [], opts \\ []) View 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.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id}.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.BigQueryDataTransfer.V1.Model.StartManualTransferRunsRequest.t):

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.StartManualTransferRunsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_transfer_configs_create(connection, parent, optional_params \\ [], opts \\ []) View Source

Creates a new data transfer configuration.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :authorizationCode (String.t): 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=&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.

    • :versionInfo (String.t): 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.

  • :body (GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t):

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_transfer_configs_delete(connection, name, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_transfer_configs_get(connection, name, optional_params \\ [], opts \\ []) View Source

Returns information about a data transfer config.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_transfer_configs_list(connection, parent, optional_params \\ [], opts \\ []) View Source

Returns information about all data transfers in the project.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): The BigQuery project id for which data sources should be returned: projects/{project_id}.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :dataSourceIds (list(String.t)): When specified, only configurations of requested data sources are returned.
    • :pageSize (integer()): Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (String.t): Pagination token, which can be used to request a specific page

of ListTransfersRequest list results. For multiple-page results, ListTransfersResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferConfigsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_transfer_configs_patch(connection, name, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The resource name of the transfer config. Transfer config names have the form of projects/{project_id}/locations/{region}/transferConfigs/{config_id}. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :authorizationCode (String.t): 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=&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.

    • :updateMask (String.t): Required list of fields to be updated in this request.
    • :versionInfo (String.t): 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.

  • :body (GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t):

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_transfer_configs_runs_delete(connection, name, optional_params \\ [], opts \\ []) View Source

Deletes the specified transfer run.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_transfer_configs_runs_get(connection, name, optional_params \\ [], opts \\ []) View Source

Returns information about the particular transfer run.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • name (String.t): The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferRun{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_transfer_configs_runs_list(connection, parent, optional_params \\ [], opts \\ []) View Source

Returns information about running and completed jobs.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id}.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (integer()): Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (String.t): Pagination token, which can be used to request a specific page

of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

  • :runAttempt (String.t): Indicates how run attempts are to be pulled.
  • :states (list(String.t)): When specified, only transfer runs with requested states are returned.

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferRunsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_transfer_configs_runs_transfer_logs_list(connection, parent, optional_params \\ [], opts \\ []) View Source

Returns user facing log messages for the data transfer run.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): Transfer run name in the form: projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :messageTypes (list(String.t)): Message types to return. If not populated - INFO, WARNING and ERROR

messages are returned.

  • :pageSize (integer()): Page size. The default page size is the maximum value of 1000 results.
  • :pageToken (String.t): Pagination token, which can be used to request a specific page of ListTransferLogsRequest list results. For multiple-page results, ListTransferLogsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferLogsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_transfer_configs_schedule_runs(connection, parent, optional_params \\ [], opts \\ []) View 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.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id}.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleTransferRunsRequest.t):

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleTransferRunsResponse{}} on success {:error, info} on failure

Link to this function

bigquerydatatransfer_projects_transfer_configs_start_manual_runs(connection, parent, optional_params \\ [], opts \\ []) View 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.

Parameters

  • connection (GoogleApi.BigQueryDataTransfer.V1.Connection): Connection to server
  • parent (String.t): Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id}.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.BigQueryDataTransfer.V1.Model.StartManualTransferRunsRequest.t):

Returns

{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.StartManualTransferRunsResponse{}} on success {:error, info} on failure