google_api_big_query_data_transfer v0.17.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
bigquerydatatransfer_projects_data_sources_check_valid_creds(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.CheckValidCredsResponse.t()}
  | {:error, Tesla.Env.t()}

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 (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}.
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.BigQueryDataTransfer.V1.Model.CheckValidCredsRequest.t) -
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_data_sources_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.DataSource.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_data_sources_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListDataSourcesResponse.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (type: 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.
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_data_sources_check_valid_creds(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.CheckValidCredsResponse.t()}
  | {:error, Tesla.Env.t()}

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 (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}.
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.BigQueryDataTransfer.V1.Model.CheckValidCredsRequest.t) -
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_data_sources_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.DataSource.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_data_sources_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListDataSourcesResponse.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (type: 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.
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Location.t()}
  | {:error, Tesla.Env.t()}

Gets information about a location.

Parameters

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

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListLocationsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists information about the supported locations for this service.

Parameters

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

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The standard list filter.
    • :pageSize (type: integer()) - The standard list page size.
    • :pageToken (type: String.t) - The standard list page token.
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_transfer_configs_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()}
  | {:error, Tesla.Env.t()}

Creates a new data transfer configuration.

Parameters

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
bigquerydatatransfer_projects_locations_transfer_configs_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Empty.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_transfer_configs_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()}
  | {:error, Tesla.Env.t()}

Returns information about a data transfer config.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_transfer_configs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferConfigsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns information about all data transfers in the project.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :dataSourceIds (type: list(String.t)) - When specified, only configurations of requested data sources are returned.
    • :pageSize (type: integer()) - Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (type: 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.
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_transfer_configs_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

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
bigquerydatatransfer_projects_locations_transfer_configs_runs_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Empty.t()}
  | {:error, Tesla.Env.t()}

Deletes the specified transfer run.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_transfer_configs_runs_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferRun.t()}
  | {:error, Tesla.Env.t()}

Returns information about the particular transfer run.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_transfer_configs_runs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferRunsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns information about running and completed jobs.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - 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}.
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (type: 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 (type: String.t) - Indicates how run attempts are to be pulled.
    • :states (type: list(String.t)) - When specified, only transfer runs with requested states are returned.
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_transfer_configs_runs_transfer_logs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferLogsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns user facing log messages for the data transfer run.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :messageTypes (type: list(String.t)) - Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
    • :pageSize (type: integer()) - Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (type: 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.
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_transfer_configs_schedule_runs(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleTransferRunsResponse.t()}
  | {:error, Tesla.Env.t()}

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 (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleTransferRunsRequest.t) -
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_locations_transfer_configs_start_manual_runs(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.BigQueryDataTransfer.V1.Model.StartManualTransferRunsResponse.t()}
  | {:error, Tesla.Env.t()}

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 (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.BigQueryDataTransfer.V1.Model.StartManualTransferRunsRequest.t) -
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_transfer_configs_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()}
  | {:error, Tesla.Env.t()}

Creates a new data transfer configuration.

Parameters

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
bigquerydatatransfer_projects_transfer_configs_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Empty.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_transfer_configs_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()}
  | {:error, Tesla.Env.t()}

Returns information about a data transfer config.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_transfer_configs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferConfigsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns information about all data transfers in the project.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :dataSourceIds (type: list(String.t)) - When specified, only configurations of requested data sources are returned.
    • :pageSize (type: integer()) - Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (type: 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.
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_transfer_configs_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

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
bigquerydatatransfer_projects_transfer_configs_runs_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Empty.t()}
  | {:error, Tesla.Env.t()}

Deletes the specified transfer run.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_transfer_configs_runs_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferRun.t()}
  | {:error, Tesla.Env.t()}

Returns information about the particular transfer run.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_transfer_configs_runs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferRunsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns information about running and completed jobs.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - 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}.
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (type: 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 (type: String.t) - Indicates how run attempts are to be pulled.
    • :states (type: list(String.t)) - When specified, only transfer runs with requested states are returned.
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_transfer_configs_runs_transfer_logs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferLogsResponse.t()}
  | {:error, Tesla.Env.t()}

Returns user facing log messages for the data transfer run.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - 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}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :messageTypes (type: list(String.t)) - Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
    • :pageSize (type: integer()) - Page size. The default page size is the maximum value of 1000 results.
    • :pageToken (type: 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.
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_transfer_configs_schedule_runs(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleTransferRunsResponse.t()}
  | {:error, Tesla.Env.t()}

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 (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleTransferRunsRequest.t) -
  • opts (type: keyword()) - Call options

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
bigquerydatatransfer_projects_transfer_configs_start_manual_runs(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.BigQueryDataTransfer.V1.Model.StartManualTransferRunsResponse.t()}
  | {:error, Tesla.Env.t()}

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 (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.BigQueryDataTransfer.V1.Model.StartManualTransferRunsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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