google_api_big_query v0.12.0 GoogleApi.BigQuery.V2.Api.Models View Source

API calls for all endpoints tagged Models.

Link to this section Summary

Link to this section Functions

Link to this function

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

Deletes the model specified by modelId from the dataset.

Parameters

  • connection (GoogleApi.BigQuery.V2.Connection): Connection to server
  • project_id (String.t): Project ID of the model to delete.
  • dataset_id (String.t): Dataset ID of the model to delete.
  • model_id (String.t): Model ID of the model to delete.
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

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

Gets the specified model resource by model ID.

Parameters

  • connection (GoogleApi.BigQuery.V2.Connection): Connection to server
  • project_id (String.t): Project ID of the requested model.
  • dataset_id (String.t): Dataset ID of the requested model.
  • model_id (String.t): Model ID of the requested model.
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

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

Link to this function

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

Lists all models in the specified dataset. Requires the READER dataset role.

Parameters

  • connection (GoogleApi.BigQuery.V2.Connection): Connection to server
  • project_id (String.t): Project ID of the models to list.
  • dataset_id (String.t): Dataset ID of the models to list.
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :maxResults (integer()): The maximum number of results per page.
    • :pageToken (String.t): Page token, returned by a previous call to request the next page of

results

Returns

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

Link to this function

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

Patch specific fields in the specified model.

Parameters

  • connection (GoogleApi.BigQuery.V2.Connection): Connection to server
  • project_id (String.t): Project ID of the model to patch.
  • dataset_id (String.t): Dataset ID of the model to patch.
  • model_id (String.t): Model ID of the model to patch.
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (GoogleApi.BigQuery.V2.Model.Model.t):

Returns

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