Dataplex V1 API - Class Google::Cloud::Dataplex::V1::CmekService::Client (v2.3.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::CmekService::Client.

Client for the CmekService service.

Dataplex Cmek Service

Inherits

  • Object

Includes

Methods

.configure

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

Configure the CmekService 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 CmekService clients
::Google::Cloud::Dataplex::V1::CmekService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the CmekService 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_encryption_config

def create_encryption_config(request, options = nil) -> ::Gapic::Operation
def create_encryption_config(parent: nil, encryption_config_id: nil, encryption_config: nil) -> ::Gapic::Operation

Create an EncryptionConfig.

Overloads 
def create_encryption_config(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_encryption_config via a request object, either of type Google::Cloud::Dataplex::V1::CreateEncryptionConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::CreateEncryptionConfigRequest, ::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_encryption_config(parent: nil, encryption_config_id: nil, encryption_config: nil) -> ::Gapic::Operation
Pass arguments to create_encryption_config 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. The location at which the EncryptionConfig is to be created.
  • encryption_config_id (::String) — Required. The ID of the EncryptionConfig to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and hyphens (-). The maximum size is 63 characters. The first character must be a letter. The last character must be a letter or a number.
  • encryption_config (::Google::Cloud::Dataplex::V1::EncryptionConfig, ::Hash) — Required. The EncryptionConfig to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::CreateEncryptionConfigRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_encryption_config

def delete_encryption_config(request, options = nil) -> ::Gapic::Operation
def delete_encryption_config(name: nil, etag: nil) -> ::Gapic::Operation

Delete an EncryptionConfig.

Overloads 
def delete_encryption_config(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_encryption_config via a request object, either of type DeleteEncryptionConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::DeleteEncryptionConfigRequest, ::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_encryption_config(name: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_encryption_config 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. The name of the EncryptionConfig to delete.
  • etag (::String) — Optional. Etag of the EncryptionConfig. This is a strong etag.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::DeleteEncryptionConfigRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_encryption_config

def get_encryption_config(request, options = nil) -> ::Google::Cloud::Dataplex::V1::EncryptionConfig
def get_encryption_config(name: nil) -> ::Google::Cloud::Dataplex::V1::EncryptionConfig

Get an EncryptionConfig.

Overloads 
def get_encryption_config(request, options = nil) -> ::Google::Cloud::Dataplex::V1::EncryptionConfig
Pass arguments to get_encryption_config via a request object, either of type GetEncryptionConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::GetEncryptionConfigRequest, ::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_encryption_config(name: nil) -> ::Google::Cloud::Dataplex::V1::EncryptionConfig
Pass arguments to get_encryption_config 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. The name of the EncryptionConfig to fetch.
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/dataplex/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::GetEncryptionConfigRequest.new

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

# The returned object is of type Google::Cloud::Dataplex::V1::EncryptionConfig.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Client)

#initialize

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

Create a new CmekService client object.

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

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

#list_encryption_configs

def list_encryption_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::EncryptionConfig>
def list_encryption_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::EncryptionConfig>

List EncryptionConfigs.

Overloads 
def list_encryption_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::EncryptionConfig>
Pass arguments to list_encryption_configs via a request object, either of type ListEncryptionConfigsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::ListEncryptionConfigsRequest, ::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_encryption_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::EncryptionConfig>
Pass arguments to list_encryption_configs 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. The location for which the EncryptionConfig is to be listed.
  • page_size (::Integer) — Optional. Maximum number of EncryptionConfigs to return. The service may return fewer than this value. If unspecified, at most 10 EncryptionConfigs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. Page token received from a previous ListEncryptionConfigs call. Provide this to retrieve the subsequent page. When paginating, the parameters - filter and order_by provided to ListEncryptionConfigs must match the call that provided the page token.
  • filter (::String) —

    Optional. Filter the EncryptionConfigs to be returned. Using bare literals: (These values will be matched anywhere it may appear in the object's field values)

    • filter=some_value Using fields: (These values will be matched only in the specified field)
    • filter=some_field=some_value Supported fields:
    • name, key, create_time, update_time, encryption_state Example:
    • filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config conjunctions: (AND, OR, NOT)
    • filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config AND mode=CMEK logical operators: (>, <, >=, <=, !=, =, :),
    • filter=create_time>2024-05-01T00:00:00.000Z
  • order_by (::String) — Optional. Order by fields for the result.
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/dataplex/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::ListEncryptionConfigsRequest.new

# Call the list_encryption_configs method.
result = client.list_encryption_configs 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::Dataplex::V1::EncryptionConfig.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::Dataplex::V1::CmekService::Operations

Get the associated client for long-running operations.

Returns

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_encryption_config

def update_encryption_config(request, options = nil) -> ::Gapic::Operation
def update_encryption_config(encryption_config: nil, update_mask: nil) -> ::Gapic::Operation

Update an EncryptionConfig.

Overloads 
def update_encryption_config(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_encryption_config via a request object, either of type UpdateEncryptionConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::UpdateEncryptionConfigRequest, ::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_encryption_config(encryption_config: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_encryption_config 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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::V1::UpdateEncryptionConfigRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end