GoogleApi.BigQuery.V2.Api.Models (google_api_big_query v0.88.0)

API calls for all endpoints tagged Models.

Summary

Functions

bigquery_models_delete(connection, project_id, dataset_id, model_id, optional_params \\ [], opts \\ [])

Deletes the model specified by modelId from the dataset.

bigquery_models_get(connection, project_id, dataset_id, model_id, optional_params \\ [], opts \\ [])

Gets the specified model resource by model ID.

bigquery_models_list(connection, project_id, dataset_id, optional_params \\ [], opts \\ [])

Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method.

bigquery_models_patch(connection, project_id, dataset_id, model_id, optional_params \\ [], opts \\ [])

Patch specific fields in the specified model.

Functions

bigquery_models_delete(connection, project_id, dataset_id, model_id, optional_params \\ [], opts \\ [])

@spec bigquery_models_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes the model specified by modelId from the dataset.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the model to delete.
dataset_id (type: String.t) - Required. Dataset ID of the model to delete.
model_id (type: String.t) - Required. Model ID of the model to delete.
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, %{}} on success
{:error, info} on failure

bigquery_models_get(connection, project_id, dataset_id, model_id, optional_params \\ [], opts \\ [])

@spec bigquery_models_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQuery.V2.Model.Model.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the specified model resource by model ID.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the requested model.
dataset_id (type: String.t) - Required. Dataset ID of the requested model.
model_id (type: String.t) - Required. Model ID of the requested model.
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.BigQuery.V2.Model.Model{}} on success
{:error, info} on failure

bigquery_models_list(connection, project_id, dataset_id, optional_params \\ [], opts \\ [])

@spec bigquery_models_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQuery.V2.Model.ListModelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the models to list.
dataset_id (type: String.t) - Required. Dataset ID of the models to list.
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").
- :maxResults (type: integer()) - The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
- :pageToken (type: String.t) - Page token, returned by a previous call to request the next page of results
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.BigQuery.V2.Model.ListModelsResponse{}} on success
{:error, info} on failure

bigquery_models_patch(connection, project_id, dataset_id, model_id, optional_params \\ [], opts \\ [])

@spec bigquery_models_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQuery.V2.Model.Model.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Patch specific fields in the specified model.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the model to patch.
dataset_id (type: String.t) - Required. Dataset ID of the model to patch.
model_id (type: String.t) - Required. Model ID of the model to patch.
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.BigQuery.V2.Model.Model.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.BigQuery.V2.Model.Model{}} on success
{:error, info} on failure