GoogleApi.BigQueryDataPolicy.V1.Api.Projects (google_api_big_query_data_policy v0.3.1)

View Source

API calls for all endpoints tagged Projects.

Summary

Functions

bigquerydatapolicy_projects_locations_data_policies_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a new data policy under a project with the given dataPolicyId (used as the display name), policy tag, and data policy type.

bigquerydatapolicy_projects_locations_data_policies_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes the data policy specified by its resource name.

bigquerydatapolicy_projects_locations_data_policies_get(connection, name, optional_params \\ [], opts \\ [])

Gets the data policy specified by its resource name.

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

Gets the IAM policy for the specified data policy.

bigquerydatapolicy_projects_locations_data_policies_list(connection, parent, optional_params \\ [], opts \\ [])

List all of the data policies in the specified parent project.

bigquerydatapolicy_projects_locations_data_policies_patch(connection, name, optional_params \\ [], opts \\ [])

Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.

bigquerydatapolicy_projects_locations_data_policies_rename(connection, name, optional_params \\ [], opts \\ [])

Renames the id (display name) of the specified data policy.

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

Sets the IAM policy for the specified data policy.

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

Returns the caller's permission on the specified data policy resource.

Functions

bigquerydatapolicy_projects_locations_data_policies_create(connection, parent, optional_params \\ [], opts \\ [])

@spec bigquerydatapolicy_projects_locations_data_policies_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataPolicy.V1.Model.DataPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new data policy under a project with the given dataPolicyId (used as the display name), policy tag, and data policy type.

Parameters

  • connection (type: GoogleApi.BigQueryDataPolicy.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource name of the project that the data policy will belong to. The format is projects/{project_number}/locations/{location_id}.
  • 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.BigQueryDataPolicy.V1.Model.DataPolicy.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryDataPolicy.V1.Model.DataPolicy{}} on success
  • {:error, info} on failure

bigquerydatapolicy_projects_locations_data_policies_delete(connection, name, optional_params \\ [], opts \\ [])

@spec bigquerydatapolicy_projects_locations_data_policies_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataPolicy.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the data policy specified by its resource name.

Parameters

  • connection (type: GoogleApi.BigQueryDataPolicy.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the data policy to delete. Format is projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.
  • 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()) - Optional. If true, the data policy will be deleted even when it is referenced by one or more table columns.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryDataPolicy.V1.Model.Empty{}} on success
  • {:error, info} on failure

bigquerydatapolicy_projects_locations_data_policies_get(connection, name, optional_params \\ [], opts \\ [])

@spec bigquerydatapolicy_projects_locations_data_policies_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataPolicy.V1.Model.DataPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the data policy specified by its resource name.

Parameters

  • connection (type: GoogleApi.BigQueryDataPolicy.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the requested data policy. Format is projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.
  • 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.BigQueryDataPolicy.V1.Model.DataPolicy{}} on success
  • {:error, info} on failure

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

@spec bigquerydatapolicy_projects_locations_data_policies_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataPolicy.V1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the IAM policy for the specified data policy.

Parameters

  • connection (type: GoogleApi.BigQueryDataPolicy.V1.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.BigQueryDataPolicy.V1.Model.GetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryDataPolicy.V1.Model.Policy{}} on success
  • {:error, info} on failure

bigquerydatapolicy_projects_locations_data_policies_list(connection, parent, optional_params \\ [], opts \\ [])

@spec bigquerydatapolicy_projects_locations_data_policies_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataPolicy.V1.Model.ListDataPoliciesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all of the data policies in the specified parent project.

Parameters

  • connection (type: GoogleApi.BigQueryDataPolicy.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource name of the project for which to list data policies. Format is projects/{project_number}/locations/{location_id}.
  • 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) - Filters the data policies by policy tags that they are associated with. Currently filter only supports "policy_tag" based filtering and OR based predicates. Sample filter can be "policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3". You may also use wildcard such as "policy_tag: projects/1/locations/us/taxonomies/2*". Please note that OR predicates cannot be used with wildcard filters.
    • :pageSize (type: integer()) - The maximum number of data policies to return. Must be a value between 1 and 1000. If not set, defaults to 50.
    • :pageToken (type: String.t) - The nextPageToken value returned from a previous list request, if any. If not set, defaults to an empty string.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryDataPolicy.V1.Model.ListDataPoliciesResponse{}} on success
  • {:error, info} on failure

bigquerydatapolicy_projects_locations_data_policies_patch(connection, name, optional_params \\ [], opts \\ [])

@spec bigquerydatapolicy_projects_locations_data_policies_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataPolicy.V1.Model.DataPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.

Parameters

  • connection (type: GoogleApi.BigQueryDataPolicy.V1.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Resource name of this data policy, in the format of projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.
  • 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").
    • :allowMissing (type: boolean()) - Optional. If set to true, and the data policy is not found, a new data policy will be created. In this situation, update_mask is ignored.
    • :updateMask (type: String.t) - The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update. Updates to the name and dataPolicyId fields are not allowed.
    • :body (type: GoogleApi.BigQueryDataPolicy.V1.Model.DataPolicy.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryDataPolicy.V1.Model.DataPolicy{}} on success
  • {:error, info} on failure

bigquerydatapolicy_projects_locations_data_policies_rename(connection, name, optional_params \\ [], opts \\ [])

@spec bigquerydatapolicy_projects_locations_data_policies_rename(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataPolicy.V1.Model.DataPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Renames the id (display name) of the specified data policy.

Parameters

  • connection (type: GoogleApi.BigQueryDataPolicy.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the data policy to rename. The format is projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}
  • 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.BigQueryDataPolicy.V1.Model.RenameDataPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryDataPolicy.V1.Model.DataPolicy{}} on success
  • {:error, info} on failure

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

@spec bigquerydatapolicy_projects_locations_data_policies_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataPolicy.V1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the IAM policy for the specified data policy.

Parameters

  • connection (type: GoogleApi.BigQueryDataPolicy.V1.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.BigQueryDataPolicy.V1.Model.SetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryDataPolicy.V1.Model.Policy{}} on success
  • {:error, info} on failure

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

@spec bigquerydatapolicy_projects_locations_data_policies_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataPolicy.V1.Model.TestIamPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the caller's permission on the specified data policy resource.

Parameters

  • connection (type: GoogleApi.BigQueryDataPolicy.V1.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.BigQueryDataPolicy.V1.Model.TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryDataPolicy.V1.Model.TestIamPermissionsResponse{}} on success
  • {:error, info} on failure