Class: Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/kms/inventory/v1/key_tracking_service/client.rb
Overview
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
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the KeyTrackingService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the KeyTrackingService Client instance.
-
#get_protected_resources_summary(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Kms::Inventory::V1::ProtectedResourcesSummary
Returns aggregate information about the resources protected by the given Cloud KMS CryptoKey.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new KeyTrackingService client object.
-
#search_protected_resources(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Kms::Inventory::V1::ProtectedResource>
Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.
Methods included from Paths
#organization_path, #protected_resources_summary_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new KeyTrackingService client object.
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/google/cloud/kms/inventory/v1/key_tracking_service/client.rb', line 115 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/kms/inventory/v1/key_tracking_service_services_pb" # 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 == 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 = ::Gapic::ServiceStub.new( ::Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the KeyTrackingService Client class.
See Configuration for a description of the configuration fields.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/google/cloud/kms/inventory/v1/key_tracking_service/client.rb', line 58 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.
94 95 96 97 |
# File 'lib/google/cloud/kms/inventory/v1/key_tracking_service/client.rb', line 94 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.
202 203 204 205 206 207 208 209 210 211 212 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 |
# File 'lib/google/cloud/kms/inventory/v1/key_tracking_service/client.rb', line 202 def get_protected_resources_summary request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_protected_resources_summary..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_protected_resources_summary.timeout, metadata: , retry_policy: @config.rpcs.get_protected_resources_summary.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @key_tracking_service_stub.call_rpc :get_protected_resources_summary, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#search_protected_resources(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Kms::Inventory::V1::ProtectedResource> #search_protected_resources(scope: nil, crypto_key: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Kms::Inventory::V1::ProtectedResource>
Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 |
# File 'lib/google/cloud/kms/inventory/v1/key_tracking_service/client.rb', line 309 def search_protected_resources request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.search_protected_resources..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.scope header_params["scope"] = request.scope end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.search_protected_resources.timeout, metadata: , retry_policy: @config.rpcs.search_protected_resources.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @key_tracking_service_stub.call_rpc :search_protected_resources, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @key_tracking_service_stub, :search_protected_resources, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |