View Source GoogleApi.BigQuery.V2.Api.Routines (google_api_big_query v0.79.0)

API calls for all endpoints tagged Routines.

Summary

Functions

bigquery_routines_delete(connection, project_id, dataset_id, routine_id, optional_params \\ [], opts \\ [])

Deletes the routine specified by routineId from the dataset.

bigquery_routines_get(connection, project_id, dataset_id, routine_id, optional_params \\ [], opts \\ [])

Gets the specified routine resource by routine ID.

bigquery_routines_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

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

Creates a new routine in the dataset.

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

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

bigquery_routines_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

bigquery_routines_update(connection, project_id, dataset_id, routine_id, optional_params \\ [], opts \\ [])

Updates information in an existing routine. The update method replaces the entire Routine resource.

Functions

bigquery_routines_delete(connection, project_id, dataset_id, routine_id, optional_params \\ [], opts \\ [])

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

Deletes the routine specified by routineId from the dataset.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the routine to delete
dataset_id (type: String.t) - Required. Dataset ID of the routine to delete
routine_id (type: String.t) - Required. Routine ID of the routine 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_routines_get(connection, project_id, dataset_id, routine_id, optional_params \\ [], opts \\ [])

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

Gets the specified routine resource by routine ID.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the requested routine
dataset_id (type: String.t) - Required. Dataset ID of the requested routine
routine_id (type: String.t) - Required. Routine ID of the requested routine
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").
- :readMask (type: String.t) - If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.
opts (type: keyword()) - Call options

Returns

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

bigquery_routines_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

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

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
resource (type: String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
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.GetIamPolicyRequest.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Creates a new routine in the dataset.

Parameters

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

Returns

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

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

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

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

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the routines to list
dataset_id (type: String.t) - Required. Dataset ID of the routines 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").
- :filter (type: String.t) - If set, then only the Routines matching this filter are returned. The supported format is routineType:{RoutineType}, where {RoutineType} is a RoutineType enum. For example: routineType:SCALAR_FUNCTION.
- :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
- :readMask (type: String.t) - If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.
opts (type: keyword()) - Call options

Returns

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

bigquery_routines_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

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

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
resource (type: String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
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.SetIamPolicyRequest.t) -
opts (type: keyword()) - Call options

Returns

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

bigquery_routines_update(connection, project_id, dataset_id, routine_id, optional_params \\ [], opts \\ [])

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

Updates information in an existing routine. The update method replaces the entire Routine resource.

Parameters

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

Returns

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