google-apis-kmsinventory_v1 0.1.0

data/lib/google/apis/kmsinventory_v1/representations.rb

@@ -0,0 +1,207 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module KmsinventoryV1
+      
+      class GoogleCloudKmsInventoryV1ListCryptoKeysResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudKmsInventoryV1ProtectedResource
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudKmsInventoryV1ProtectedResourcesSummary
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudKmsV1CryptoKey
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudKmsV1CryptoKeyVersion
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudKmsV1CryptoKeyVersionTemplate
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudKmsV1ExternalProtectionLevelOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudKmsV1KeyOperationAttestation
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudKmsV1KeyOperationAttestationCertificateChains
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudKmsInventoryV1ListCryptoKeysResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :crypto_keys, as: 'cryptoKeys', class: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1CryptoKey, decorator: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1CryptoKey::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
+      class GoogleCloudKmsInventoryV1ProtectedResource
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :cloud_product, as: 'cloudProduct'
+          property :create_time, as: 'createTime'
+          property :crypto_key_version, as: 'cryptoKeyVersion'
+          hash :labels, as: 'labels'
+          property :location, as: 'location'
+          property :name, as: 'name'
+          property :project, as: 'project'
+          property :project_id, as: 'projectId'
+          property :resource_type, as: 'resourceType'
+        end
+      end
+      
+      class GoogleCloudKmsInventoryV1ProtectedResourcesSummary
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :cloud_products, as: 'cloudProducts'
+          hash :locations, as: 'locations'
+          property :name, as: 'name'
+          property :project_count, as: 'projectCount'
+          property :resource_count, :numeric_string => true, as: 'resourceCount'
+          hash :resource_types, as: 'resourceTypes'
+        end
+      end
+      
+      class GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :next_page_token, as: 'nextPageToken'
+          collection :protected_resources, as: 'protectedResources', class: Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1ProtectedResource, decorator: Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1ProtectedResource::Representation
+      
+        end
+      end
+      
+      class GoogleCloudKmsV1CryptoKey
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :crypto_key_backend, as: 'cryptoKeyBackend'
+          property :destroy_scheduled_duration, as: 'destroyScheduledDuration'
+          property :import_only, as: 'importOnly'
+          hash :labels, as: 'labels'
+          property :name, as: 'name'
+          property :next_rotation_time, as: 'nextRotationTime'
+          property :primary, as: 'primary', class: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1CryptoKeyVersion, decorator: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1CryptoKeyVersion::Representation
+      
+          property :purpose, as: 'purpose'
+          property :rotation_period, as: 'rotationPeriod'
+          property :version_template, as: 'versionTemplate', class: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1CryptoKeyVersionTemplate, decorator: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1CryptoKeyVersionTemplate::Representation
+      
+        end
+      end
+      
+      class GoogleCloudKmsV1CryptoKeyVersion
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :algorithm, as: 'algorithm'
+          property :attestation, as: 'attestation', class: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1KeyOperationAttestation, decorator: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1KeyOperationAttestation::Representation
+      
+          property :create_time, as: 'createTime'
+          property :destroy_event_time, as: 'destroyEventTime'
+          property :destroy_time, as: 'destroyTime'
+          property :external_protection_level_options, as: 'externalProtectionLevelOptions', class: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1ExternalProtectionLevelOptions, decorator: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1ExternalProtectionLevelOptions::Representation
+      
+          property :generate_time, as: 'generateTime'
+          property :import_failure_reason, as: 'importFailureReason'
+          property :import_job, as: 'importJob'
+          property :import_time, as: 'importTime'
+          property :name, as: 'name'
+          property :protection_level, as: 'protectionLevel'
+          property :reimport_eligible, as: 'reimportEligible'
+          property :state, as: 'state'
+        end
+      end
+      
+      class GoogleCloudKmsV1CryptoKeyVersionTemplate
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :algorithm, as: 'algorithm'
+          property :protection_level, as: 'protectionLevel'
+        end
+      end
+      
+      class GoogleCloudKmsV1ExternalProtectionLevelOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :ekm_connection_key_path, as: 'ekmConnectionKeyPath'
+          property :external_key_uri, as: 'externalKeyUri'
+        end
+      end
+      
+      class GoogleCloudKmsV1KeyOperationAttestation
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :cert_chains, as: 'certChains', class: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1KeyOperationAttestationCertificateChains, decorator: Google::Apis::KmsinventoryV1::GoogleCloudKmsV1KeyOperationAttestationCertificateChains::Representation
+      
+          property :content, :base64 => true, as: 'content'
+          property :format, as: 'format'
+        end
+      end
+      
+      class GoogleCloudKmsV1KeyOperationAttestationCertificateChains
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :cavium_certs, as: 'caviumCerts'
+          collection :google_card_certs, as: 'googleCardCerts'
+          collection :google_partition_certs, as: 'googlePartitionCerts'
+        end
+      end
+    end
+  end
+end

data/lib/google/apis/kmsinventory_v1/service.rb

@@ -0,0 +1,181 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module KmsinventoryV1
+      # KMS Inventory API
+      #
+      # 
+      #
+      # @example
+      #    require 'google/apis/kmsinventory_v1'
+      #
+      #    Kmsinventory = Google::Apis::KmsinventoryV1 # Alias the module
+      #    service = Kmsinventory::KmsinventoryService.new
+      #
+      # @see https://cloud.google.com/kms/
+      class KmsinventoryService < Google::Apis::Core::BaseService
+        # @return [String]
+        #  API key. Your API key identifies your project and provides you with API access,
+        #  quota, and reports. Required unless you provide an OAuth 2.0 token.
+        attr_accessor :key
+
+        # @return [String]
+        #  Available to use for quota purposes for server-side applications. Can be any
+        #  arbitrary string assigned to a user, but should not exceed 40 characters.
+        attr_accessor :quota_user
+
+        def initialize
+          super('https://kmsinventory.googleapis.com/', '',
+                client_name: 'google-apis-kmsinventory_v1',
+                client_version: Google::Apis::KmsinventoryV1::GEM_VERSION)
+          @batch_path = 'batch'
+        end
+        
+        # Returns metadata about the resources protected by the given Cloud KMS
+        # CryptoKey in the given Cloud organization.
+        # @param [String] scope
+        #   Required. Resource name of the organization. Example: organizations/123
+        # @param [String] crypto_key
+        #   Required. The resource name of the CryptoKey.
+        # @param [Fixnum] page_size
+        #   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.
+        # @param [String] page_token
+        #   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.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def search_organization_protected_resources(scope, crypto_key: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+scope}/protectedResources:search', options)
+          command.response_representation = Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse::Representation
+          command.response_class = Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse
+          command.params['scope'] = scope unless scope.nil?
+          command.query['cryptoKey'] = crypto_key unless crypto_key.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # 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.
+        # @param [String] parent
+        #   Required. The Google Cloud project for which to retrieve key metadata, in the
+        #   format `projects/*`
+        # @param [Fixnum] page_size
+        #   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.
+        # @param [String] page_token
+        #   Optional. Pass this into a subsequent request in order to receive the next
+        #   page of results.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1ListCryptoKeysResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1ListCryptoKeysResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_crypto_keys(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/cryptoKeys', options)
+          command.response_representation = Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1ListCryptoKeysResponse::Representation
+          command.response_class = Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1ListCryptoKeysResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # 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.
+        # @param [String] name
+        #   Required. The resource name of the CryptoKey.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1ProtectedResourcesSummary] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1ProtectedResourcesSummary]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_location_key_ring_crypto_key_protected_resources_summary(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}/protectedResourcesSummary', options)
+          command.response_representation = Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1ProtectedResourcesSummary::Representation
+          command.response_class = Google::Apis::KmsinventoryV1::GoogleCloudKmsInventoryV1ProtectedResourcesSummary
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+
+        protected
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        end
+      end
+    end
+  end
+end

data/lib/google/apis/kmsinventory_v1.rb

@@ -0,0 +1,36 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/kmsinventory_v1/service.rb'
+require 'google/apis/kmsinventory_v1/classes.rb'
+require 'google/apis/kmsinventory_v1/representations.rb'
+require 'google/apis/kmsinventory_v1/gem_version.rb'
+
+module Google
+  module Apis
+    # KMS Inventory API
+    #
+    # 
+    #
+    # @see https://cloud.google.com/kms/
+    module KmsinventoryV1
+      # Version of the KMS Inventory API this client connects to.
+      # This is NOT the gem version.
+      VERSION = 'V1'
+
+      # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
+      AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
+    end
+  end
+end

data/lib/google-apis-kmsinventory_v1.rb

@@ -0,0 +1,15 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "google/apis/kmsinventory_v1"

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: google-apis-kmsinventory_v1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Google LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-apis-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+description: This is the simple REST client for KMS Inventory API V1. Simple REST
+  clients are Ruby client libraries that provide access to Google services via their
+  HTTP REST API endpoints. These libraries are generated and updated automatically
+  based on the discovery documents published by the service, and they handle most
+  concerns such as authentication, pagination, retry, timeouts, and logging. You can
+  use this client to access the KMS Inventory API, but note that some services may
+  provide a separate modern client that is easier to use.
+email: googleapis-packages@google.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.md
+- OVERVIEW.md
+- lib/google-apis-kmsinventory_v1.rb
+- lib/google/apis/kmsinventory_v1.rb
+- lib/google/apis/kmsinventory_v1/classes.rb
+- lib/google/apis/kmsinventory_v1/gem_version.rb
+- lib/google/apis/kmsinventory_v1/representations.rb
+- lib/google/apis/kmsinventory_v1/service.rb
+homepage: https://github.com/google/google-api-ruby-client
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
+  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-kmsinventory_v1/CHANGELOG.md
+  documentation_uri: https://googleapis.dev/ruby/google-apis-kmsinventory_v1/v0.1.0
+  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-kmsinventory_v1
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.2
+signing_key: 
+specification_version: 4
+summary: Simple REST client for KMS Inventory API V1
+test_files: []