Class: Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/kms/inventory/v1/key_tracking_service/rest/client.rb

Overview

REST client for the KeyTrackingService service.

Returns information about the resources in an org that are protected by a given Cloud KMS key via CMEK.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#organization_path, #protected_resources_summary_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new KeyTrackingService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Rest::Client.new

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

Yields:

  • (config) —

    Configure the KeyTrackingService client.

Yield Parameters:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/google/cloud/kms/inventory/v1/key_tracking_service/rest/client.rb', line 132

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @key_tracking_service_stub = ::Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the KeyTrackingService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all KeyTrackingService clients
::Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/cloud/kms/inventory/v1/key_tracking_service/rest/client.rb', line 66

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Kms", "Inventory", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.get_protected_resources_summary.timeout = 60.0

    default_config.rpcs.search_protected_resources.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the KeyTrackingService 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



102
103
104
105
 
# File 'lib/google/cloud/kms/inventory/v1/key_tracking_service/rest/client.rb', line 102

def configure
  yield @config if block_given?
  @config
end

#get_protected_resources_summary(request, options = nil) ⇒ ::Google::Cloud::Kms::Inventory::V1::ProtectedResourcesSummary #get_protected_resources_summary(name: nil) ⇒ ::Google::Cloud::Kms::Inventory::V1::ProtectedResourcesSummary

Returns aggregate information about the resources protected by the given Cloud KMS CryptoKey. Only resources within the same Cloud organization as the key will be returned. The project that holds the key must be part of an organization in order for this call to succeed.

Examples:

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::KeyTrackingService::Rest::Client.new

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

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

# The returned object is of type Google::Cloud::Kms::Inventory::V1::ProtectedResourcesSummary.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/google/cloud/kms/inventory/v1/key_tracking_service/rest/client.rb', line 213

def get_protected_resources_summary request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::Inventory::V1::GetProtectedResourcesSummaryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_protected_resources_summary.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Kms::Inventory::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_protected_resources_summary.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_protected_resources_summary.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @key_tracking_service_stub.get_protected_resources_summary request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_protected_resources(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::Inventory::V1::ProtectedResource> #search_protected_resources(scope: nil, crypto_key: nil, page_size: nil, page_token: nil, resource_types: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::Inventory::V1::ProtectedResource>

Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.

Examples:

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::KeyTrackingService::Rest::Client.new

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

# Call the search_protected_resources method.
result = client.search_protected_resources 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::Inventory::V1::ProtectedResource.
  p item
end

Overloads:

  • #search_protected_resources(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::Inventory::V1::ProtectedResource>

    Pass arguments to search_protected_resources via a request object, either of type SearchProtectedResourcesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Kms::Inventory::V1::SearchProtectedResourcesRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #search_protected_resources(scope: nil, crypto_key: nil, page_size: nil, page_token: nil, resource_types: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::Inventory::V1::ProtectedResource>

    Pass arguments to search_protected_resources 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:

    • scope (::String) (defaults to: nil) —

      Required. Resource name of the organization. Example: organizations/123

    • crypto_key (::String) (defaults to: nil) —

      Required. The resource name of the CryptoKey.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of resources to return. The service may return fewer than this value. If unspecified, at most 500 resources will be returned. The maximum value is 500; values above 500 will be coerced to 500.

    • page_token (::String) (defaults to: nil) —

      A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token.

    • resource_types (::Array<::String>) (defaults to: nil) —

      Optional. A list of resource types that this request searches for. If empty, it will search all the trackable resource types.

      Regular expressions are also supported. For example:

      • compute.googleapis.com.* snapshots resources whose type starts with compute.googleapis.com.
      • .*Image snapshots resources whose type ends with Image.
      • .*Image.* snapshots resources whose type contains Image.

      See RE2 for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/google/cloud/kms/inventory/v1/key_tracking_service/rest/client.rb', line 329

def search_protected_resources request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Kms::Inventory::V1::SearchProtectedResourcesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.search_protected_resources.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Kms::Inventory::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_protected_resources.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search_protected_resources.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @key_tracking_service_stub.search_protected_resources request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @key_tracking_service_stub, :search_protected_resources, "protected_resources", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/cloud/kms/inventory/v1/key_tracking_service/rest/client.rb', line 112

def universe_domain
  @key_tracking_service_stub.universe_domain
end