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

API calls for all endpoints tagged Tables.

Summary

Functions

bigquery_tables_delete(connection, project_id, dataset_id, table_id, optional_params \\ [], opts \\ [])

Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.

bigquery_tables_get(connection, project_id, dataset_id, table_id, optional_params \\ [], opts \\ [])

Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.

bigquery_tables_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_tables_insert(connection, project_id, dataset_id, optional_params \\ [], opts \\ [])

Creates a new, empty table in the dataset.

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

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

bigquery_tables_patch(connection, project_id, dataset_id, table_id, optional_params \\ [], opts \\ [])

Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports RFC5789 patch semantics.

bigquery_tables_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_tables_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

bigquery_tables_update(connection, project_id, dataset_id, table_id, optional_params \\ [], opts \\ [])

Updates information in an existing table. The update method replaces the entire Table resource, whereas the patch method only replaces fields that are provided in the submitted Table resource.

Functions

Link to this function

bigquery_tables_delete(connection, project_id, dataset_id, table_id, optional_params \\ [], opts \\ [])

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

Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • project_id (type: String.t) - Required. Project ID of the table to delete
  • dataset_id (type: String.t) - Required. Dataset ID of the table to delete
  • table_id (type: String.t) - Required. Table ID of the table 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
Link to this function

bigquery_tables_get(connection, project_id, dataset_id, table_id, optional_params \\ [], opts \\ [])

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

Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • project_id (type: String.t) - Required. Project ID of the requested table
  • dataset_id (type: String.t) - Required. Dataset ID of the requested table
  • table_id (type: String.t) - Required. Table ID of the requested table
  • 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").
    • :selectedFields (type: String.t) - List of table schema fields to return (comma-separated). If unspecified, all fields are returned. A fieldMask cannot be used here because the fields will automatically be converted from camelCase to snake_case and the conversion will fail if there are underscores. Since these are fields in BigQuery table schemas, underscores are allowed.
    • :view (type: String.t) - Optional. Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQuery.V2.Model.Table{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec bigquery_tables_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
Link to this function

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

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

Creates a new, empty table 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 table
  • dataset_id (type: String.t) - Required. Dataset ID of the new table
  • 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.Table.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQuery.V2.Model.Table{}} on success
  • {:error, info} on failure
Link to this function

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

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

Lists all tables 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 tables to list
  • dataset_id (type: String.t) - Required. Dataset ID of the tables 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.TableList{}} on success
  • {:error, info} on failure
Link to this function

bigquery_tables_patch(connection, project_id, dataset_id, table_id, optional_params \\ [], opts \\ [])

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

Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports RFC5789 patch semantics.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • project_id (type: String.t) - Required. Project ID of the table to update
  • dataset_id (type: String.t) - Required. Dataset ID of the table to update
  • table_id (type: String.t) - Required. Table ID of the table 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").
    • :autodetect_schema (type: boolean()) - Optional. When true will autodetect schema, else will keep original schema
    • :body (type: GoogleApi.BigQuery.V2.Model.Table.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQuery.V2.Model.Table{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec bigquery_tables_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
Link to this function

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

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

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • resource (type: String.t) - REQUIRED: The resource for which the policy detail 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.TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQuery.V2.Model.TestIamPermissionsResponse{}} on success
  • {:error, info} on failure
Link to this function

bigquery_tables_update(connection, project_id, dataset_id, table_id, optional_params \\ [], opts \\ [])

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

Updates information in an existing table. The update method replaces the entire Table resource, whereas the patch method only replaces fields that are provided in the submitted Table resource.

Parameters

  • connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
  • project_id (type: String.t) - Required. Project ID of the table to update
  • dataset_id (type: String.t) - Required. Dataset ID of the table to update
  • table_id (type: String.t) - Required. Table ID of the table 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").
    • :autodetect_schema (type: boolean()) - Optional. When true will autodetect schema, else will keep original schema
    • :body (type: GoogleApi.BigQuery.V2.Model.Table.t) -
  • opts (type: keyword()) - Call options

Returns

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