# Binary Authorization API - Module Google::Cloud::BinaryAuthorization (v2.1.0)

2.1.0 (latest) 2.0.2 1.5.0 1.4.1 1.3.0 1.2.0 1.1.0 1.0.1 Reference documentation and code samples for the Binary Authorization API module Google::Cloud::BinaryAuthorization.

## Methods

### .binauthz_management_service

    def self.binauthz_management_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for BinauthzManagementService.

By default, this returns an instance of
[Google::Cloud::BinaryAuthorization::V1::BinauthzManagementService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-binary_authorization-v1/latest/Google-Cloud-BinaryAuthorization-V1-BinauthzManagementService-Client)
for a gRPC client for version V1 of the API.
However, you can 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.
You can also specify a different transport by passing `:rest` or `:grpc` in
the `transport` parameter.

Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the BinauthzManagementService service.
You can determine whether the method will succeed by calling
[BinaryAuthorization.binauthz_management_service_available?](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-binary_authorization/latest/Google-Cloud-BinaryAuthorization#Google__Cloud__BinaryAuthorization_binauthz_management_service_available__class_ "Google::Cloud::BinaryAuthorization.binauthz_management_service_available? (method)").

#### 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`.
- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`.
**Returns**

- (::Object) --- A client object for the specified version.

### .binauthz_management_service_available?

    def self.binauthz_management_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the BinauthzManagementService service is supported by the current client.
If true, you can retrieve a client object by calling [BinaryAuthorization.binauthz_management_service](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-binary_authorization/latest/Google-Cloud-BinaryAuthorization#Google__Cloud__BinaryAuthorization_binauthz_management_service_class_ "Google::Cloud::BinaryAuthorization.binauthz_management_service (method)").
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the BinauthzManagementService service,
or if the versioned client gem needs an update to support the BinauthzManagementService service.
**Parameters**

- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.
- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`.
**Returns**

- (boolean) --- Whether the service is available.

### .configure

    def self.configure() -> ::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 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**

- (::Google::Cloud.configure.binary_authorization)
**Returns**

- (::Google::Cloud::Config) --- The default configuration used by this library

### .system_policy

    def self.system_policy(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for SystemPolicy.


By default, this returns an instance of
[Google::Cloud::BinaryAuthorization::V1::SystemPolicy::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-binary_authorization-v1/latest/Google-Cloud-BinaryAuthorization-V1-SystemPolicy-Client)
for a gRPC client for version V1 of the API.
However, you can 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.
You can also specify a different transport by passing `:rest` or `:grpc` in
the `transport` parameter.

<br />

Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the SystemPolicy service.
You can determine whether the method will succeed by calling
[BinaryAuthorization.system_policy_available?](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-binary_authorization/latest/Google-Cloud-BinaryAuthorization#Google__Cloud__BinaryAuthorization_system_policy_available__class_ "Google::Cloud::BinaryAuthorization.system_policy_available? (method)").

#### About SystemPolicy

<br />

<br />

API for working with the system policy.
**Parameters**

- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.
- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`.
**Returns**

- (::Object) --- A client object for the specified version.

### .system_policy_available?

    def self.system_policy_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the SystemPolicy service is supported by the current client.
If true, you can retrieve a client object by calling [BinaryAuthorization.system_policy](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-binary_authorization/latest/Google-Cloud-BinaryAuthorization#Google__Cloud__BinaryAuthorization_system_policy_class_ "Google::Cloud::BinaryAuthorization.system_policy (method)").
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the SystemPolicy service,
or if the versioned client gem needs an update to support the SystemPolicy service.
**Parameters**

- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.
- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`.
**Returns**

- (boolean) --- Whether the service is available.

### .validation_helper

    def self.validation_helper(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for ValidationHelper.


By default, this returns an instance of
[Google::Cloud::BinaryAuthorization::V1::ValidationHelper::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-binary_authorization-v1/latest/Google-Cloud-BinaryAuthorization-V1-ValidationHelper-Client)
for a gRPC client for version V1 of the API.
However, you can 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.
You can also specify a different transport by passing `:rest` or `:grpc` in
the `transport` parameter.

<br />

Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the ValidationHelper service.
You can determine whether the method will succeed by calling
[BinaryAuthorization.validation_helper_available?](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-binary_authorization/latest/Google-Cloud-BinaryAuthorization#Google__Cloud__BinaryAuthorization_validation_helper_available__class_ "Google::Cloud::BinaryAuthorization.validation_helper_available? (method)").

#### About ValidationHelper

<br />

<br />

BinAuthz Attestor verification
**Parameters**

- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.
- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`.
**Returns**

- (::Object) --- A client object for the specified version.

### .validation_helper_available?

    def self.validation_helper_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the ValidationHelper service is supported by the current client.
If true, you can retrieve a client object by calling [BinaryAuthorization.validation_helper](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-binary_authorization/latest/Google-Cloud-BinaryAuthorization#Google__Cloud__BinaryAuthorization_validation_helper_class_ "Google::Cloud::BinaryAuthorization.validation_helper (method)").
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the ValidationHelper service,
or if the versioned client gem needs an update to support the ValidationHelper service.
**Parameters**

- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.
- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`.
**Returns**

- (boolean) --- Whether the service is available.

## Constants

### VERSION

**value:**"2.1.0"