class Google::Cloud::BinaryAuthorization::V1::ValidationHelper::Client
Client
for the ValidationHelper
service.
BinAuthz Attestor verification
Attributes
@private
Public Class Methods
Configure the ValidationHelper
Client
class.
See {::Google::Cloud::BinaryAuthorization::V1::ValidationHelper::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all ValidationHelper clients ::Google::Cloud::BinaryAuthorization::V1::ValidationHelper::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/binary_authorization/v1/validation_helper/client.rb, line 54 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "BinaryAuthorization", "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 end yield @configure if block_given? @configure end
Create a new ValidationHelper
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::BinaryAuthorization::V1::ValidationHelper::Client.new # Create a client using a custom configuration client = ::Google::Cloud::BinaryAuthorization::V1::ValidationHelper::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the ValidationHelper
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/binary_authorization/v1/validation_helper/client.rb, line 107 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/binaryauthorization/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 == Client.configure.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 @validation_helper_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::BinaryAuthorization::V1::ValidationHelperV1::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the ValidationHelper
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::BinaryAuthorization::V1::ValidationHelper::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/binary_authorization/v1/validation_helper/client.rb, line 86 def configure yield @config if block_given? @config end
Returns whether the given Attestation for the given image URI was signed by the given Attestor
@overload validate_attestation_occurrence
(request, options = nil)
Pass arguments to `validate_attestation_occurrence` via a request object, either of type {::Google::Cloud::BinaryAuthorization::V1::ValidateAttestationOccurrenceRequest} or an equivalent Hash. @param request [::Google::Cloud::BinaryAuthorization::V1::ValidateAttestationOccurrenceRequest, ::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 validate_attestation_occurrence
(attestor: nil, attestation: nil, occurrence_note: nil, occurrence_resource_uri: nil)
Pass arguments to `validate_attestation_occurrence` 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 attestor [::String] Required. The resource name of the {::Google::Cloud::BinaryAuthorization::V1::Attestor Attestor} of the [occurrence][grafeas.v1.Occurrence], in the format `projects/*/attestors/*`. @param attestation [::Grafeas::V1::AttestationOccurrence, ::Hash] Required. An {::Grafeas::V1::AttestationOccurrence AttestationOccurrence} to be checked that it can be verified by the Attestor. It does not have to be an existing entity in Container Analysis. It must otherwise be a valid AttestationOccurrence. @param occurrence_note [::String] Required. The resource name of the [Note][grafeas.v1.Note] to which the containing [Occurrence][grafeas.v1.Occurrence] is associated. @param occurrence_resource_uri [::String] Required. The URI of the artifact (e.g. container image) that is the subject of the containing [Occurrence][grafeas.v1.Occurrence].
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::BinaryAuthorization::V1::ValidateAttestationOccurrenceResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::BinaryAuthorization::V1::ValidateAttestationOccurrenceResponse]
@raise [::Google::Cloud::Error] if the RPC is aborted.
@example Basic example
require "google/cloud/binary_authorization/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::BinaryAuthorization::V1::ValidationHelper::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::BinaryAuthorization::V1::ValidateAttestationOccurrenceRequest.new # Call the validate_attestation_occurrence method. result = client.validate_attestation_occurrence request # The returned object is of type Google::Cloud::BinaryAuthorization::V1::ValidateAttestationOccurrenceResponse. p result
# File lib/google/cloud/binary_authorization/v1/validation_helper/client.rb, line 203 def validate_attestation_occurrence request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BinaryAuthorization::V1::ValidateAttestationOccurrenceRequest # 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.validate_attestation_occurrence.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::BinaryAuthorization::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.attestor header_params["attestor"] = request.attestor 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.validate_attestation_occurrence.timeout, metadata: metadata, retry_policy: @config.rpcs.validate_attestation_occurrence.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @validation_helper_stub.call_rpc :validate_attestation_occurrence, 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