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

API calls for all endpoints tagged RowAccessPolicies.

Summary

Functions

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

Deletes provided row access policies.

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

Deletes a row access policy.

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

Gets the specified row access policy by policy ID.

bigquery_row_access_policies_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_row_access_policies_insert(connection, project_id, dataset_id, table_id, optional_params \\ [], opts \\ [])

Creates a row access policy.

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

Lists all row access policies on the specified table.

bigquery_row_access_policies_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_row_access_policies_update(connection, project_id, dataset_id, table_id, policy_id, optional_params \\ [], opts \\ [])

Updates a row access policy.

Functions

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

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

Deletes provided row access policies.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the table to delete the row access policies.
dataset_id (type: String.t) - Required. Dataset ID of the table to delete the row access policies.
table_id (type: String.t) - Required. Table ID of the table to delete the row access policies.
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.BatchDeleteRowAccessPoliciesRequest.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Deletes a row access policy.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the table to delete the row access policy.
dataset_id (type: String.t) - Required. Dataset ID of the table to delete the row access policy.
table_id (type: String.t) - Required. Table ID of the table to delete the row access policy.
policy_id (type: String.t) - Required. Policy ID of the row access policy.
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").
- :force (type: boolean()) - If set to true, it deletes the row access policy even if it's the last row access policy on the table and the deletion will widen the access rather narrowing it.
opts (type: keyword()) - Call options

Returns

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

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

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

Gets the specified row access policy by policy ID.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the table to get the row access policy.
dataset_id (type: String.t) - Required. Dataset ID of the table to get the row access policy.
table_id (type: String.t) - Required. Table ID of the table to get the row access policy.
policy_id (type: String.t) - Required. Policy ID of the row access policy.
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.RowAccessPolicy{}} on success
{:error, info} on failure

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

@spec bigquery_row_access_policies_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_row_access_policies_insert(connection, project_id, dataset_id, table_id, optional_params \\ [], opts \\ [])

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

Creates a row access policy.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the table to get the row access policy.
dataset_id (type: String.t) - Required. Dataset ID of the table to get the row access policy.
table_id (type: String.t) - Required. Table ID of the table to get the row access policy.
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.RowAccessPolicy.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Lists all row access policies on the specified table.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the row access policies to list.
dataset_id (type: String.t) - Required. Dataset ID of row access policies to list.
table_id (type: String.t) - Required. Table ID of the table to list row access policies.
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()) - 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.ListRowAccessPoliciesResponse{}} on success
{:error, info} on failure

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

@spec bigquery_row_access_policies_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()}

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

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

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

Updates a row access policy.

Parameters

connection (type: GoogleApi.BigQuery.V2.Connection.t) - Connection to server
project_id (type: String.t) - Required. Project ID of the table to get the row access policy.
dataset_id (type: String.t) - Required. Dataset ID of the table to get the row access policy.
table_id (type: String.t) - Required. Table ID of the table to get the row access policy.
policy_id (type: String.t) - Required. Policy ID of the row access policy.
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.RowAccessPolicy.t) -
opts (type: keyword()) - Call options

Returns

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