KMS Inventory V1 API - Class Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Client (v0.1.0)

Reference documentation and code samples for the KMS Inventory V1 API class Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Client.

Client for the KeyDashboardService service.

Provides a cross-region view of all Cloud KMS keys in a given Cloud project.

Inherits

  • Object

Includes

Methods

.configure

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

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

#configure

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

Configure the KeyDashboardService 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

#initialize

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

Create a new KeyDashboardService client object.

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

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

#list_crypto_keys

def list_crypto_keys(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::CryptoKey>
def list_crypto_keys(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::CryptoKey>

Returns cryptographic keys managed by Cloud KMS in a given Cloud project. Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.

Overloads 
def list_crypto_keys(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::CryptoKey>
Pass arguments to list_crypto_keys via a request object, either of type ListCryptoKeysRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Kms::Inventory::V1::ListCryptoKeysRequest, ::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_crypto_keys(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Kms::V1::CryptoKey>
Pass arguments to list_crypto_keys 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 Google Cloud project for which to retrieve key metadata, in the format projects/*
  • page_size (::Integer) — Optional. The maximum number of keys to return. The service may return fewer than this value. If unspecified, at most 1000 keys will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. Pass this into a subsequent request in order to receive the next page of results.
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/kms/inventory/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Kms::Inventory::V1::ListCryptoKeysRequest.new

# Call the list_crypto_keys method.
result = client.list_crypto_keys 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::Kms::V1::CryptoKey.
  p item
end