# frozen_string_literal: true # Copyright 2023 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 # # https://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. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/confidentialcomputing/v1/service_pb" require "google/cloud/location" module Google module Cloud module ConfidentialComputing module V1 module ConfidentialComputing ## # Client for the ConfidentialComputing service. # # Service describing handlers for resources # class Client include Paths # @private attr_reader :confidential_computing_stub ## # Configure the ConfidentialComputing Client class. # # See {::Google::Cloud::ConfidentialComputing::V1::ConfidentialComputing::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all ConfidentialComputing clients # ::Google::Cloud::ConfidentialComputing::V1::ConfidentialComputing::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "ConfidentialComputing", "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.timeout = 60.0 default_config.rpcs.create_challenge.timeout = 60.0 default_config.rpcs.create_challenge.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.verify_attestation.timeout = 60.0 default_config.rpcs.verify_attestation.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end ## # Configure the ConfidentialComputing 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 {::Google::Cloud::ConfidentialComputing::V1::ConfidentialComputing::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # Create a new ConfidentialComputing client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::ConfidentialComputing::V1::ConfidentialComputing::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::ConfidentialComputing::V1::ConfidentialComputing::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the ConfidentialComputing client. # @yieldparam config [Client::Configuration] # 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/confidentialcomputing/v1/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 @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @confidential_computing_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::ConfidentialComputing::V1::ConfidentialComputing::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Client] # attr_reader :location_client # Service calls ## # Creates a new Challenge in a given project and location. # # @overload create_challenge(request, options = nil) # Pass arguments to `create_challenge` via a request object, either of type # {::Google::Cloud::ConfidentialComputing::V1::CreateChallengeRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfidentialComputing::V1::CreateChallengeRequest, ::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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload create_challenge(parent: nil, challenge: nil) # Pass arguments to `create_challenge` 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). # # @param parent [::String] # Required. The resource name of the location where the Challenge will be # used, in the format `projects/*/locations/*`. # @param challenge [::Google::Cloud::ConfidentialComputing::V1::Challenge, ::Hash] # Required. The Challenge to be created. Currently this field can be empty as # all the Challenge fields are set by the server. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::ConfidentialComputing::V1::Challenge] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::ConfidentialComputing::V1::Challenge] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/confidential_computing/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfidentialComputing::V1::ConfidentialComputing::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfidentialComputing::V1::CreateChallengeRequest.new # # # Call the create_challenge method. # result = client.create_challenge request # # # The returned object is of type Google::Cloud::ConfidentialComputing::V1::Challenge. # p result # def create_challenge request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfidentialComputing::V1::CreateChallengeRequest # 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 metadata = @config.rpcs.create_challenge.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::ConfidentialComputing::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_challenge.timeout, metadata: metadata, retry_policy: @config.rpcs.create_challenge.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @confidential_computing_stub.call_rpc :create_challenge, request, options: 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 ## # Verifies the provided attestation info, returning a signed OIDC token. # # @overload verify_attestation(request, options = nil) # Pass arguments to `verify_attestation` via a request object, either of type # {::Google::Cloud::ConfidentialComputing::V1::VerifyAttestationRequest} or an equivalent Hash. # # @param request [::Google::Cloud::ConfidentialComputing::V1::VerifyAttestationRequest, ::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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload verify_attestation(challenge: nil, gcp_credentials: nil, tpm_attestation: nil, confidential_space_info: nil, token_options: nil) # Pass arguments to `verify_attestation` 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). # # @param challenge [::String] # Required. The name of the Challenge whose nonce was used to generate the # attestation, in the format `projects/*/locations/*/challenges/*`. The # provided Challenge will be consumed, and cannot be used again. # @param gcp_credentials [::Google::Cloud::ConfidentialComputing::V1::GcpCredentials, ::Hash] # Optional. Credentials used to populate the "emails" claim in the # claims_token. # @param tpm_attestation [::Google::Cloud::ConfidentialComputing::V1::TpmAttestation, ::Hash] # Required. The TPM-specific data provided by the attesting platform, used to # populate any of the claims regarding platform state. # @param confidential_space_info [::Google::Cloud::ConfidentialComputing::V1::ConfidentialSpaceInfo, ::Hash] # Optional. Optional information related to the Confidential Space TEE. # @param token_options [::Google::Cloud::ConfidentialComputing::V1::TokenOptions, ::Hash] # Optional. A collection of optional, workload-specified claims that modify # the token output. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::ConfidentialComputing::V1::VerifyAttestationResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::ConfidentialComputing::V1::VerifyAttestationResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/confidential_computing/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::ConfidentialComputing::V1::ConfidentialComputing::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::ConfidentialComputing::V1::VerifyAttestationRequest.new # # # Call the verify_attestation method. # result = client.verify_attestation request # # # The returned object is of type Google::Cloud::ConfidentialComputing::V1::VerifyAttestationResponse. # p result # def verify_attestation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfidentialComputing::V1::VerifyAttestationRequest # 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 metadata = @config.rpcs.verify_attestation.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::ConfidentialComputing::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.challenge header_params["challenge"] = request.challenge end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.verify_attestation.timeout, metadata: metadata, retry_policy: @config.rpcs.verify_attestation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @confidential_computing_stub.call_rpc :verify_attestation, request, options: 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 ## # Configuration class for the ConfidentialComputing API. # # This class represents the configuration for ConfidentialComputing, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::ConfidentialComputing::V1::ConfidentialComputing::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # create_challenge to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::ConfidentialComputing::V1::ConfidentialComputing::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.create_challenge.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::ConfidentialComputing::V1::ConfidentialComputing::Client.new do |config| # config.timeout = 10.0 # config.rpcs.create_challenge.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"confidentialcomputing.googleapis.com"`. # @return [::String] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`GRPC::Core::Channel`) a gRPC channel with included credentials # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] channel_args # Extra parameters passed to the gRPC channel. Note: this is ignored if a # `GRPC::Core::Channel` object is provided as the credential. # @return [::Hash] # @!attribute [rw] interceptors # An array of interceptors that are run before calls are executed. # @return [::Array<::GRPC::ClientInterceptor>] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional gRPC headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "confidentialcomputing.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the ConfidentialComputing API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `create_challenge` # @return [::Gapic::Config::Method] # attr_reader :create_challenge ## # RPC-specific configuration for `verify_attestation` # @return [::Gapic::Config::Method] # attr_reader :verify_attestation # @private def initialize parent_rpcs = nil create_challenge_config = parent_rpcs.create_challenge if parent_rpcs.respond_to? :create_challenge @create_challenge = ::Gapic::Config::Method.new create_challenge_config verify_attestation_config = parent_rpcs.verify_attestation if parent_rpcs.respond_to? :verify_attestation @verify_attestation = ::Gapic::Config::Method.new verify_attestation_config yield self if block_given? end end end end end end end end end