Module: Google::Cloud::BinaryAuthorization

Defined in:
lib/google/cloud/binary_authorization.rb,
lib/google/cloud/binary_authorization/version.rb

Constant Summary collapse

VERSION = 
"1.1.0"

Class Method Summary collapse

Class Method Details

.binauthz_management_service(version: :v1, &block) ⇒ BinauthzManagementService::Client

Create a new client object for BinauthzManagementService.

By default, this returns an instance of Google::Cloud::BinaryAuthorization::V1::BinauthzManagementService::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the BinauthzManagementService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About BinauthzManagementService

Google Cloud Management Service for Binary Authorization admission policies and attestation authorities.

This API implements a REST model with the following objects:

  • Policy
  • Attestor

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (BinauthzManagementService::Client) —

    A client object for the specified version.



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/google/cloud/binary_authorization.rb', line 72

def self.binauthz_management_service version: :v1, &block
  require "google/cloud/binary_authorization/#{version.to_s.downcase}"

  package_name = Google::Cloud::BinaryAuthorization
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::BinaryAuthorization.const_get package_name
  package_module.const_get(:BinauthzManagementService).const_get(:Client).new(&block)
end

.configure {|::Google::Cloud.configure.binary_authorization| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-binary_authorization library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional gRPC headers to be sent with the call.
  • retry_policy (type: Hash) - 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<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



171
172
173
174
175
 
# File 'lib/google/cloud/binary_authorization.rb', line 171

def self.configure
  yield ::Google::Cloud.configure.binary_authorization if block_given?

  ::Google::Cloud.configure.binary_authorization
end

.system_policy(version: :v1, &block) ⇒ SystemPolicy::Client

Create a new client object for SystemPolicy.

By default, this returns an instance of Google::Cloud::BinaryAuthorization::V1::SystemPolicy::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the SystemPolicy service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About SystemPolicy

API for working with the system policy.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (SystemPolicy::Client) —

    A client object for the specified version.



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/google/cloud/binary_authorization.rb', line 102

def self.system_policy version: :v1, &block
  require "google/cloud/binary_authorization/#{version.to_s.downcase}"

  package_name = Google::Cloud::BinaryAuthorization
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::BinaryAuthorization.const_get package_name
  package_module.const_get(:SystemPolicy).const_get(:Client).new(&block)
end

.validation_helper(version: :v1, &block) ⇒ ValidationHelper::Client

Create a new client object for ValidationHelper.

By default, this returns an instance of Google::Cloud::BinaryAuthorization::V1::ValidationHelper::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the ValidationHelper service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About ValidationHelper

BinAuthz Attestor verification

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (ValidationHelper::Client) —

    A client object for the specified version.



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/google/cloud/binary_authorization.rb', line 132

def self.validation_helper version: :v1, &block
  require "google/cloud/binary_authorization/#{version.to_s.downcase}"

  package_name = Google::Cloud::BinaryAuthorization
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::BinaryAuthorization.const_get package_name
  package_module.const_get(:ValidationHelper).const_get(:Client).new(&block)
end