class Google::Cloud::BinaryAuthorization::V1::BinauthzManagementService::Client

Client for the BinauthzManagementService service.

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

This API implements a REST model with the following objects:

Attributes

binauthz_management_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the BinauthzManagementService Client class.

See {::Google::Cloud::BinaryAuthorization::V1::BinauthzManagementService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all BinauthzManagementService clients
::Google::Cloud::BinaryAuthorization::V1::BinauthzManagementService::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/binauthz_management_service/client.rb, line 62
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.rpcs.get_policy.timeout = 600.0
    default_config.rpcs.get_policy.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.update_policy.timeout = 600.0
    default_config.rpcs.update_policy.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.create_attestor.timeout = 600.0

    default_config.rpcs.get_attestor.timeout = 600.0
    default_config.rpcs.get_attestor.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.update_attestor.timeout = 600.0
    default_config.rpcs.update_attestor.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_attestors.timeout = 600.0
    default_config.rpcs.list_attestors.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.delete_attestor.timeout = 600.0
    default_config.rpcs.delete_attestor.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new BinauthzManagementService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::BinaryAuthorization::V1::BinauthzManagementService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::BinaryAuthorization::V1::BinauthzManagementService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the BinauthzManagementService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/binary_authorization/v1/binauthz_management_service/client.rb, line 147
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

  @binauthz_management_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::BinaryAuthorization::V1::BinauthzManagementServiceV1::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the BinauthzManagementService 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::BinauthzManagementService::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/binauthz_management_service/client.rb, line 126
def configure
  yield @config if block_given?
  @config
end
create_attestor(request, options = nil) { |response, operation| ... } click to toggle source

Creates an {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor}, and returns a copy of the new {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor}. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor} already exists.

@overload create_attestor(request, options = nil)

Pass arguments to `create_attestor` via a request object, either of type
{::Google::Cloud::BinaryAuthorization::V1::CreateAttestorRequest} or an equivalent Hash.

@param request [::Google::Cloud::BinaryAuthorization::V1::CreateAttestorRequest, ::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_attestor(parent: nil, attestor_id: nil, attestor: nil)

Pass arguments to `create_attestor` 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 parent of this {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor}.
@param attestor_id [::String]
  Required. The {::Google::Cloud::BinaryAuthorization::V1::Attestor attestors} ID.
@param attestor [::Google::Cloud::BinaryAuthorization::V1::Attestor, ::Hash]
  Required. The initial {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor} value. The service will
  overwrite the {::Google::Cloud::BinaryAuthorization::V1::Attestor#name attestor name} field with the resource name,
  in the format `projects/*/attestors/*`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::BinaryAuthorization::V1::Attestor] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::BinaryAuthorization::V1::Attestor]

@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::BinauthzManagementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BinaryAuthorization::V1::CreateAttestorRequest.new

# Call the create_attestor method.
result = client.create_attestor request

# The returned object is of type Google::Cloud::BinaryAuthorization::V1::Attestor.
p result
# File lib/google/cloud/binary_authorization/v1/binauthz_management_service/client.rb, line 421
def create_attestor request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BinaryAuthorization::V1::CreateAttestorRequest

  # 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_attestor.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.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_attestor.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_attestor.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @binauthz_management_service_stub.call_rpc :create_attestor, 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
delete_attestor(request, options = nil) { |response, operation| ... } click to toggle source

Deletes an {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor}. Returns NOT_FOUND if the {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor} does not exist.

@overload delete_attestor(request, options = nil)

Pass arguments to `delete_attestor` via a request object, either of type
{::Google::Cloud::BinaryAuthorization::V1::DeleteAttestorRequest} or an equivalent Hash.

@param request [::Google::Cloud::BinaryAuthorization::V1::DeleteAttestorRequest, ::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 delete_attestor(name: nil)

Pass arguments to `delete_attestor` 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 name [::String]
  Required. The name of the {::Google::Cloud::BinaryAuthorization::V1::Attestor attestors} to delete, in the format
  `projects/*/attestors/*`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Protobuf::Empty]

@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::BinauthzManagementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BinaryAuthorization::V1::DeleteAttestorRequest.new

# Call the delete_attestor method.
result = client.delete_attestor request

# The returned object is of type Google::Protobuf::Empty.
p result
# File lib/google/cloud/binary_authorization/v1/binauthz_management_service/client.rb, line 784
def delete_attestor request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BinaryAuthorization::V1::DeleteAttestorRequest

  # 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.delete_attestor.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.name
    header_params["name"] = request.name
  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.delete_attestor.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_attestor.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @binauthz_management_service_stub.call_rpc :delete_attestor, 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
get_attestor(request, options = nil) { |response, operation| ... } click to toggle source

Gets an {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor}. Returns NOT_FOUND if the {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor} does not exist.

@overload get_attestor(request, options = nil)

Pass arguments to `get_attestor` via a request object, either of type
{::Google::Cloud::BinaryAuthorization::V1::GetAttestorRequest} or an equivalent Hash.

@param request [::Google::Cloud::BinaryAuthorization::V1::GetAttestorRequest, ::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 get_attestor(name: nil)

Pass arguments to `get_attestor` 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 name [::String]
  Required. The name of the {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor} to retrieve, in the format
  `projects/*/attestors/*`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::BinaryAuthorization::V1::Attestor] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::BinaryAuthorization::V1::Attestor]

@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::BinauthzManagementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BinaryAuthorization::V1::GetAttestorRequest.new

# Call the get_attestor method.
result = client.get_attestor request

# The returned object is of type Google::Cloud::BinaryAuthorization::V1::Attestor.
p result
# File lib/google/cloud/binary_authorization/v1/binauthz_management_service/client.rb, line 508
def get_attestor request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BinaryAuthorization::V1::GetAttestorRequest

  # 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.get_attestor.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.name
    header_params["name"] = request.name
  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.get_attestor.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_attestor.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @binauthz_management_service_stub.call_rpc :get_attestor, 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
get_policy(request, options = nil) { |response, operation| ... } click to toggle source

A {::Google::Cloud::BinaryAuthorization::V1::Policy policy} specifies the {::Google::Cloud::BinaryAuthorization::V1::Attestor attestors} that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy.

Gets the {::Google::Cloud::BinaryAuthorization::V1::Policy policy} for this project. Returns a default {::Google::Cloud::BinaryAuthorization::V1::Policy policy} if the project does not have one.

@overload get_policy(request, options = nil)

Pass arguments to `get_policy` via a request object, either of type
{::Google::Cloud::BinaryAuthorization::V1::GetPolicyRequest} or an equivalent Hash.

@param request [::Google::Cloud::BinaryAuthorization::V1::GetPolicyRequest, ::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 get_policy(name: nil)

Pass arguments to `get_policy` 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 name [::String]
  Required. The resource name of the {::Google::Cloud::BinaryAuthorization::V1::Policy policy} to retrieve,
  in the format `projects/*/policy`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::BinaryAuthorization::V1::Policy] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::BinaryAuthorization::V1::Policy]

@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::BinauthzManagementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BinaryAuthorization::V1::GetPolicyRequest.new

# Call the get_policy method.
result = client.get_policy request

# The returned object is of type Google::Cloud::BinaryAuthorization::V1::Policy.
p result
# File lib/google/cloud/binary_authorization/v1/binauthz_management_service/client.rb, line 236
def get_policy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BinaryAuthorization::V1::GetPolicyRequest

  # 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.get_policy.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.name
    header_params["name"] = request.name
  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.get_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_policy.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @binauthz_management_service_stub.call_rpc :get_policy, 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
list_attestors(request, options = nil) { |response, operation| ... } click to toggle source

Lists {::Google::Cloud::BinaryAuthorization::V1::Attestor attestors}. Returns INVALID_ARGUMENT if the project does not exist.

@overload list_attestors(request, options = nil)

Pass arguments to `list_attestors` via a request object, either of type
{::Google::Cloud::BinaryAuthorization::V1::ListAttestorsRequest} or an equivalent Hash.

@param request [::Google::Cloud::BinaryAuthorization::V1::ListAttestorsRequest, ::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 list_attestors(parent: nil, page_size: nil, page_token: nil)

Pass arguments to `list_attestors` 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 project associated with the
  {::Google::Cloud::BinaryAuthorization::V1::Attestor attestors}, in the format `projects/*`.
@param page_size [::Integer]
  Requested page size. The server may return fewer results than requested. If
  unspecified, the server will pick an appropriate default.
@param page_token [::String]
  A token identifying a page of results the server should return. Typically,
  this is the value of {::Google::Cloud::BinaryAuthorization::V1::ListAttestorsResponse#next_page_token ListAttestorsResponse.next_page_token} returned
  from the previous call to the `ListAttestors` method.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::BinaryAuthorization::V1::Attestor>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::BinaryAuthorization::V1::Attestor>]

@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::BinauthzManagementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BinaryAuthorization::V1::ListAttestorsRequest.new

# Call the list_attestors method.
result = client.list_attestors request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::BinaryAuthorization::V1::Attestor.
  p response
end
# File lib/google/cloud/binary_authorization/v1/binauthz_management_service/client.rb, line 696
def list_attestors request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BinaryAuthorization::V1::ListAttestorsRequest

  # 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.list_attestors.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.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.list_attestors.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_attestors.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @binauthz_management_service_stub.call_rpc :list_attestors, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @binauthz_management_service_stub, :list_attestors, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
update_attestor(request, options = nil) { |response, operation| ... } click to toggle source

Updates an {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor}. Returns NOT_FOUND if the {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor} does not exist.

@overload update_attestor(request, options = nil)

Pass arguments to `update_attestor` via a request object, either of type
{::Google::Cloud::BinaryAuthorization::V1::UpdateAttestorRequest} or an equivalent Hash.

@param request [::Google::Cloud::BinaryAuthorization::V1::UpdateAttestorRequest, ::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 update_attestor(attestor: nil)

Pass arguments to `update_attestor` 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 [::Google::Cloud::BinaryAuthorization::V1::Attestor, ::Hash]
  Required. The updated {::Google::Cloud::BinaryAuthorization::V1::Attestor attestor} value. The service will
  overwrite the {::Google::Cloud::BinaryAuthorization::V1::Attestor#name attestor name} field with the resource name
  in the request URL, in the format `projects/*/attestors/*`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::BinaryAuthorization::V1::Attestor] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::BinaryAuthorization::V1::Attestor]

@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::BinauthzManagementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BinaryAuthorization::V1::UpdateAttestorRequest.new

# Call the update_attestor method.
result = client.update_attestor request

# The returned object is of type Google::Cloud::BinaryAuthorization::V1::Attestor.
p result
# File lib/google/cloud/binary_authorization/v1/binauthz_management_service/client.rb, line 596
def update_attestor request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BinaryAuthorization::V1::UpdateAttestorRequest

  # 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.update_attestor.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&.name
    header_params["attestor.name"] = request.attestor.name
  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.update_attestor.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_attestor.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @binauthz_management_service_stub.call_rpc :update_attestor, 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
update_policy(request, options = nil) { |response, operation| ... } click to toggle source

Creates or updates a project’s {::Google::Cloud::BinaryAuthorization::V1::Policy policy}, and returns a copy of the new {::Google::Cloud::BinaryAuthorization::V1::Policy policy}. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed.

@overload update_policy(request, options = nil)

Pass arguments to `update_policy` via a request object, either of type
{::Google::Cloud::BinaryAuthorization::V1::UpdatePolicyRequest} or an equivalent Hash.

@param request [::Google::Cloud::BinaryAuthorization::V1::UpdatePolicyRequest, ::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 update_policy(policy: nil)

Pass arguments to `update_policy` 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 policy [::Google::Cloud::BinaryAuthorization::V1::Policy, ::Hash]
  Required. A new or updated {::Google::Cloud::BinaryAuthorization::V1::Policy policy} value. The service will
  overwrite the {::Google::Cloud::BinaryAuthorization::V1::Policy#name policy name} field with the resource name in
  the request URL, in the format `projects/*/policy`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::BinaryAuthorization::V1::Policy] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::BinaryAuthorization::V1::Policy]

@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::BinauthzManagementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::BinaryAuthorization::V1::UpdatePolicyRequest.new

# Call the update_policy method.
result = client.update_policy request

# The returned object is of type Google::Cloud::BinaryAuthorization::V1::Policy.
p result
# File lib/google/cloud/binary_authorization/v1/binauthz_management_service/client.rb, line 327
def update_policy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BinaryAuthorization::V1::UpdatePolicyRequest

  # 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.update_policy.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.policy&.name
    header_params["policy.name"] = request.policy.name
  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.update_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_policy.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @binauthz_management_service_stub.call_rpc :update_policy, 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