google_api_big_query v0.63.0

GoogleApi.BigQuery.V2.Api.RowAccessPolicies (google_api_big_query v0.63.0) View Source

API calls for all endpoints tagged RowAccessPolicies.

Link to this section Summary

Functions

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

Lists all row access policies on the specified table.

bigquery_row_access_policies_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_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.

Link to this section Functions

Link to this function

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

View Source

Specs

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 the operation documentation for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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_row_access_policies_list(connection, project_id, dataset_id, table_id, optional_params \\ [], opts \\ [])

View Source

Specs

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
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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
Link to this function

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

View Source

Specs

bigquery_row_access_policies_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 the operation documentation for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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_row_access_policies_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])

View Source

Specs

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()}

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 the operation documentation for the appropriate value for this field.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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