BigQuery Data Policy Service V1 API - Class Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client (v0.6.0)

Reference documentation and code samples for the BigQuery Data Policy Service V1 API class Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.

Client for the DataPolicyService service.

Data Policy Service provides APIs for managing the label-policy bindings.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the DataPolicyService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all DataPolicyService clients
::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the DataPolicyService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_data_policy

def create_data_policy(request, options = nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
def create_data_policy(parent: nil, data_policy: nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy

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

Overloads 
def create_data_policy(request, options = nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
Pass arguments to create_data_policy via a request object, either of type CreateDataPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataPolicies::V1::CreateDataPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_data_policy(parent: nil, data_policy: nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
Pass arguments to create_data_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Resource name of the project that the data policy will belong to. The format is projects/{project_number}/locations/{location_id}.
  • data_policy (::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy, ::Hash) — Required. The data policy to create. The name field does not need to be provided for the data policy creation.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_policies/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataPolicies::V1::CreateDataPolicyRequest.new

# Call the create_data_policy method.
result = client.create_data_policy request

# The returned object is of type Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy.
p result

#delete_data_policy

def delete_data_policy(request, options = nil) -> ::Google::Protobuf::Empty
def delete_data_policy(name: nil) -> ::Google::Protobuf::Empty

Deletes the data policy specified by its resource name.

Overloads 
def delete_data_policy(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_data_policy via a request object, either of type Google::Cloud::Bigquery::DataPolicies::V1::DeleteDataPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataPolicies::V1::DeleteDataPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_data_policy(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_data_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. Resource name of the data policy to delete. Format is projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_policies/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataPolicies::V1::DeleteDataPolicyRequest.new

# Call the delete_data_policy method.
result = client.delete_data_policy request

# The returned object is of type Google::Protobuf::Empty.
p result

#get_data_policy

def get_data_policy(request, options = nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
def get_data_policy(name: nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy

Gets the data policy specified by its resource name.

Overloads 
def get_data_policy(request, options = nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
Pass arguments to get_data_policy via a request object, either of type GetDataPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataPolicies::V1::GetDataPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_data_policy(name: nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
Pass arguments to get_data_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. Resource name of the requested data policy. Format is projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_policies/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataPolicies::V1::GetDataPolicyRequest.new

# Call the get_data_policy method.
result = client.get_data_policy request

# The returned object is of type Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy.
p result

#get_iam_policy

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

Gets the IAM policy for the specified data policy.

Overloads 
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_policies/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::GetIamPolicyRequest.new

# Call the get_iam_policy method.
result = client.get_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new DataPolicyService client object.

Yields
  • (config) — Configure the DataPolicyService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new do |config|
  config.timeout = 10.0
end

#list_data_policies

def list_data_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy>
def list_data_policies(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy>

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

Overloads 
def list_data_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy>
Pass arguments to list_data_policies via a request object, either of type ListDataPoliciesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataPolicies::V1::ListDataPoliciesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_data_policies(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy>
Pass arguments to list_data_policies via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Resource name of the project for which to list data policies. Format is projects/{project_number}/locations/{location_id}.
  • page_size (::Integer) — The maximum number of data policies to return. Must be a value between 1 and 1000. If not set, defaults to 50.
  • page_token (::String) — The nextPageToken value returned from a previous list request, if any. If not set, defaults to an empty string.
  • filter (::String) — 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.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_policies/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataPolicies::V1::ListDataPoliciesRequest.new

# Call the list_data_policies method.
result = client.list_data_policies request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy.
  p item
end

#rename_data_policy

def rename_data_policy(request, options = nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
def rename_data_policy(name: nil, new_data_policy_id: nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy

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

Overloads 
def rename_data_policy(request, options = nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
Pass arguments to rename_data_policy via a request object, either of type RenameDataPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataPolicies::V1::RenameDataPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def rename_data_policy(name: nil, new_data_policy_id: nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
Pass arguments to rename_data_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Resource name of the data policy to rename. The format is projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}
  • new_data_policy_id (::String) — Required. The new data policy id.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_policies/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataPolicies::V1::RenameDataPolicyRequest.new

# Call the rename_data_policy method.
result = client.rename_data_policy request

# The returned object is of type Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy.
p result

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

Sets the IAM policy for the specified data policy.

Overloads 
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

    paths: "bindings, etag"

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_policies/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::SetIamPolicyRequest.new

# Call the set_iam_policy method.
result = client.set_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

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

Overloads 
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • permissions (::Array<::String>) — The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_policies/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::TestIamPermissionsRequest.new

# Call the test_iam_permissions method.
result = client.test_iam_permissions request

# The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
p result

#update_data_policy

def update_data_policy(request, options = nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
def update_data_policy(data_policy: nil, update_mask: nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy

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

Overloads 
def update_data_policy(request, options = nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
Pass arguments to update_data_policy via a request object, either of type UpdateDataPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataPolicies::V1::UpdateDataPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_data_policy(data_policy: nil, update_mask: nil) -> ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy
Pass arguments to update_data_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • data_policy (::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy, ::Hash) — Required. Update the data policy's metadata.

    The target data policy is determined by the name field. Other fields are updated to the specified values based on the field masks.

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_policies/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataPolicies::V1::UpdateDataPolicyRequest.new

# Call the update_data_policy method.
result = client.update_data_policy request

# The returned object is of type Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy.
p result