View Source GoogleApi.BigQueryDataTransfer.V1.Api.Projects (google_api_big_query_data_transfer v0.28.1)
API calls for all endpoints tagged Projects
.
Summary
Functions
Returns true if valid credentials exist for the given data source and requesting user.
Retrieves a supported data source and returns its settings.
Lists supported data sources and returns their settings.
Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.
Returns true if valid credentials exist for the given data source and requesting user.
Retrieves a supported data source and returns its settings.
Lists supported data sources and returns their settings.
Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.
Gets information about a location.
Lists information about the supported locations for this service.
Creates a new data transfer configuration.
Deletes a data transfer configuration, including any associated transfer runs and logs.
Returns information about a data transfer config.
Returns information about all transfer configs owned by a project in the specified location.
Updates a data transfer configuration. All fields must be set, even if they are not updated.
Deletes the specified transfer run.
Returns information about the particular transfer run.
Returns information about running and completed transfer runs.
Returns log messages for the transfer run.
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.
Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the BigQuery UI. Data transfers configurations of unenrolled data sources will not be scheduled.
Creates a new data transfer configuration.
Deletes a data transfer configuration, including any associated transfer runs and logs.
Returns information about a data transfer config.
Returns information about all transfer configs owned by a project in the specified location.
Updates a data transfer configuration. All fields must be set, even if they are not updated.
Deletes the specified transfer run.
Returns information about the particular transfer run.
Returns information about running and completed transfer runs.
Returns log messages for the transfer run.
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.
Functions
bigquerydatatransfer_projects_data_sources_check_valid_creds(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_data_sources_check_valid_creds( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.CheckValidCredsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns true if valid credentials exist for the given data source and requesting user.
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}
orprojects/{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
bigquerydatatransfer_projects_data_sources_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_data_sources_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.DataSource.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a supported data source and returns its settings.
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}
orprojects/{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
bigquerydatatransfer_projects_data_sources_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_data_sources_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListDataSourcesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists supported data sources and returns their settings.
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}
orprojects/{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 ofListDataSourcesRequest
list results. For multiple-page results,ListDataSourcesResponse
outputs anext_page
token, which can be used as thepage_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
bigquerydatatransfer_projects_enroll_data_sources(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_enroll_data_sources( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.
Parameters
-
connection
(type:GoogleApi.BigQueryDataTransfer.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the project resource in the form:projects/{project_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.EnrollDataSourcesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.Empty{}}
on success -
{:error, info}
on failure
bigquerydatatransfer_projects_locations_data_sources_check_valid_creds(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_data_sources_check_valid_creds( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.CheckValidCredsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns true if valid credentials exist for the given data source and requesting user.
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}
orprojects/{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
bigquerydatatransfer_projects_locations_data_sources_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_data_sources_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.DataSource.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a supported data source and returns its settings.
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}
orprojects/{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
bigquerydatatransfer_projects_locations_data_sources_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_data_sources_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListDataSourcesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists supported data sources and returns their settings.
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}
orprojects/{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 ofListDataSourcesRequest
list results. For multiple-page results,ListDataSourcesResponse
outputs anext_page
token, which can be used as thepage_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
bigquerydatatransfer_projects_locations_enroll_data_sources(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_enroll_data_sources( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.
Parameters
-
connection
(type:GoogleApi.BigQueryDataTransfer.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the project resource in the form:projects/{project_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.EnrollDataSourcesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.Empty{}}
on success -
{:error, info}
on failure
bigquerydatatransfer_projects_locations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Location.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
bigquerydatatransfer_projects_locations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
) - A filter to narrow down results to a preferred subset. The filtering language accepts strings like"displayName=tokyo"
, and is documented in more detail in AIP-160. -
:pageSize
(type:integer()
) - The maximum number of results to return. If not set, the service selects a default. -
:pageToken
(type:String.t
) - A page token received from thenext_page_token
field in the response. Send that page token to receive the subsequent page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.ListLocationsResponse{}}
on success -
{:error, info}
on failure
bigquerydatatransfer_projects_locations_transfer_configs_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_transfer_configs_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new data transfer configuration.
Parameters
-
connection
(type:GoogleApi.BigQueryDataTransfer.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. -
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"). -
:authorizationCode
(type:String.t
) - Deprecated: Authorization code was required whentransferConfig.dataSourceId
is 'youtube_channel' but it is no longer used in any data sources. Useversion_info
instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only iftransferConfig.dataSourceId
is 'youtube_channel' and new credentials are needed, as indicated byCheckValidCreds
. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes The client_id is the OAuth client_id of the data source as returned by ListDataSources method. data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set whenservice_account_name
is used to create the transfer config. -
:serviceAccountName
(type:String.t
) - Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts. -
:versionInfo
(type:String.t
) - Optional version info. This parameter replacesauthorization_code
which is no longer used in any data sources. This is required only iftransferConfig.dataSourceId
is 'youtube_channel' or new credentials are needed, as indicated byCheckValidCreds
. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes The client_id is the OAuth client_id of the data source as returned by ListDataSources method. data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set whenservice_account_name
is used to create the transfer config. -
:body
(type:GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{}}
on success -
{:error, info}
on failure
bigquerydatatransfer_projects_locations_transfer_configs_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_transfer_configs_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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}
orprojects/{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
bigquerydatatransfer_projects_locations_transfer_configs_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_transfer_configs_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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}
orprojects/{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
bigquerydatatransfer_projects_locations_transfer_configs_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_transfer_configs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferConfigsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns information about all transfer configs owned by a project in the specified location.
Parameters
-
connection
(type:GoogleApi.BigQueryDataTransfer.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The BigQuery project id for which transfer configs should be returned:projects/{project_id}
orprojects/{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 ofListTransfersRequest
list results. For multiple-page results,ListTransfersResponse
outputs anext_page
token, which can be used as thepage_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
bigquerydatatransfer_projects_locations_transfer_configs_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_transfer_configs_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a data transfer configuration. All fields must be set, even if they are not updated.
Parameters
-
connection
(type:GoogleApi.BigQueryDataTransfer.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Identifier. The resource name of the transfer config. Transfer config names have the form eitherprojects/{project_id}/locations/{region}/transferConfigs/{config_id}
orprojects/{project_id}/transferConfigs/{config_id}
, whereconfig_id
is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. -
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"). -
:authorizationCode
(type:String.t
) - Deprecated: Authorization code was required whentransferConfig.dataSourceId
is 'youtube_channel' but it is no longer used in any data sources. Useversion_info
instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only iftransferConfig.dataSourceId
is 'youtube_channel' and new credentials are needed, as indicated byCheckValidCreds
. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes The client_id is the OAuth client_id of the data source as returned by ListDataSources method. data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set whenservice_account_name
is used to update the transfer config. -
:serviceAccountName
(type:String.t
) - Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts. -
:updateMask
(type:String.t
) - Required. Required list of fields to be updated in this request. -
:versionInfo
(type:String.t
) - Optional version info. This parameter replacesauthorization_code
which is no longer used in any data sources. This is required only iftransferConfig.dataSourceId
is 'youtube_channel' or new credentials are needed, as indicated byCheckValidCreds
. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes The client_id is the OAuth client_id of the data source as returned by ListDataSources method. data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set whenservice_account_name
is used to update the transfer config. -
:body
(type:GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{}}
on success -
{:error, info}
on failure
bigquerydatatransfer_projects_locations_transfer_configs_runs_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_transfer_configs_runs_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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}
orprojects/{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
bigquerydatatransfer_projects_locations_transfer_configs_runs_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_transfer_configs_runs_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferRun.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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}
orprojects/{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
bigquerydatatransfer_projects_locations_transfer_configs_runs_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_transfer_configs_runs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferRunsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns information about running and completed transfer runs.
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}
orprojects/{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 ofListTransferRunsRequest
list results. For multiple-page results,ListTransferRunsResponse
outputs anext_page
token, which can be used as thepage_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
bigquerydatatransfer_projects_locations_transfer_configs_runs_transfer_logs_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_transfer_configs_runs_transfer_logs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferLogsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns log messages for the 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}
orprojects/{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 ofListTransferLogsRequest
list results. For multiple-page results,ListTransferLogsResponse
outputs anext_page
token, which can be used as thepage_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
bigquerydatatransfer_projects_locations_transfer_configs_schedule_runs(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_transfer_configs_schedule_runs( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleTransferRunsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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}
orprojects/{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
bigquerydatatransfer_projects_locations_transfer_configs_start_manual_runs(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_transfer_configs_start_manual_runs( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.StartManualTransferRunsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
) - Required. Transfer configuration name in the form:projects/{project_id}/transferConfigs/{config_id}
orprojects/{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
bigquerydatatransfer_projects_locations_unenroll_data_sources(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_locations_unenroll_data_sources( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the BigQuery UI. Data transfers configurations of unenrolled data sources will not be scheduled.
Parameters
-
connection
(type:GoogleApi.BigQueryDataTransfer.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the project resource in the form:projects/{project_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.UnenrollDataSourcesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.Empty{}}
on success -
{:error, info}
on failure
bigquerydatatransfer_projects_transfer_configs_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_transfer_configs_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new data transfer configuration.
Parameters
-
connection
(type:GoogleApi.BigQueryDataTransfer.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. -
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"). -
:authorizationCode
(type:String.t
) - Deprecated: Authorization code was required whentransferConfig.dataSourceId
is 'youtube_channel' but it is no longer used in any data sources. Useversion_info
instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only iftransferConfig.dataSourceId
is 'youtube_channel' and new credentials are needed, as indicated byCheckValidCreds
. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes The client_id is the OAuth client_id of the data source as returned by ListDataSources method. data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set whenservice_account_name
is used to create the transfer config. -
:serviceAccountName
(type:String.t
) - Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts. -
:versionInfo
(type:String.t
) - Optional version info. This parameter replacesauthorization_code
which is no longer used in any data sources. This is required only iftransferConfig.dataSourceId
is 'youtube_channel' or new credentials are needed, as indicated byCheckValidCreds
. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes The client_id is the OAuth client_id of the data source as returned by ListDataSources method. data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set whenservice_account_name
is used to create the transfer config. -
:body
(type:GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{}}
on success -
{:error, info}
on failure
bigquerydatatransfer_projects_transfer_configs_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_transfer_configs_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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}
orprojects/{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
bigquerydatatransfer_projects_transfer_configs_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_transfer_configs_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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}
orprojects/{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
bigquerydatatransfer_projects_transfer_configs_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_transfer_configs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferConfigsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns information about all transfer configs owned by a project in the specified location.
Parameters
-
connection
(type:GoogleApi.BigQueryDataTransfer.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The BigQuery project id for which transfer configs should be returned:projects/{project_id}
orprojects/{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 ofListTransfersRequest
list results. For multiple-page results,ListTransfersResponse
outputs anext_page
token, which can be used as thepage_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
bigquerydatatransfer_projects_transfer_configs_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_transfer_configs_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a data transfer configuration. All fields must be set, even if they are not updated.
Parameters
-
connection
(type:GoogleApi.BigQueryDataTransfer.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Identifier. The resource name of the transfer config. Transfer config names have the form eitherprojects/{project_id}/locations/{region}/transferConfigs/{config_id}
orprojects/{project_id}/transferConfigs/{config_id}
, whereconfig_id
is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. -
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"). -
:authorizationCode
(type:String.t
) - Deprecated: Authorization code was required whentransferConfig.dataSourceId
is 'youtube_channel' but it is no longer used in any data sources. Useversion_info
instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only iftransferConfig.dataSourceId
is 'youtube_channel' and new credentials are needed, as indicated byCheckValidCreds
. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes The client_id is the OAuth client_id of the data source as returned by ListDataSources method. data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set whenservice_account_name
is used to update the transfer config. -
:serviceAccountName
(type:String.t
) - Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts. -
:updateMask
(type:String.t
) - Required. Required list of fields to be updated in this request. -
:versionInfo
(type:String.t
) - Optional version info. This parameter replacesauthorization_code
which is no longer used in any data sources. This is required only iftransferConfig.dataSourceId
is 'youtube_channel' or new credentials are needed, as indicated byCheckValidCreds
. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes The client_id is the OAuth client_id of the data source as returned by ListDataSources method. data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set whenservice_account_name
is used to update the transfer config. -
:body
(type:GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{}}
on success -
{:error, info}
on failure
bigquerydatatransfer_projects_transfer_configs_runs_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_transfer_configs_runs_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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}
orprojects/{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
bigquerydatatransfer_projects_transfer_configs_runs_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_transfer_configs_runs_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferRun.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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}
orprojects/{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
bigquerydatatransfer_projects_transfer_configs_runs_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_transfer_configs_runs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferRunsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns information about running and completed transfer runs.
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}
orprojects/{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 ofListTransferRunsRequest
list results. For multiple-page results,ListTransferRunsResponse
outputs anext_page
token, which can be used as thepage_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
bigquerydatatransfer_projects_transfer_configs_runs_transfer_logs_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_transfer_configs_runs_transfer_logs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ListTransferLogsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns log messages for the 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}
orprojects/{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 ofListTransferLogsRequest
list results. For multiple-page results,ListTransferLogsResponse
outputs anext_page
token, which can be used as thepage_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
bigquerydatatransfer_projects_transfer_configs_schedule_runs(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_transfer_configs_schedule_runs( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.ScheduleTransferRunsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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}
orprojects/{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
bigquerydatatransfer_projects_transfer_configs_start_manual_runs(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec bigquerydatatransfer_projects_transfer_configs_start_manual_runs( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.StartManualTransferRunsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
) - Required. Transfer configuration name in the form:projects/{project_id}/transferConfigs/{config_id}
orprojects/{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