Binary Authorization V1 API - Class Google::Cloud::BinaryAuthorization::V1::SystemPolicy::Rest::Client (v0.3.0)

Reference documentation and code samples for the Binary Authorization V1 API class Google::Cloud::BinaryAuthorization::V1::SystemPolicy::Rest::Client.

REST client for the SystemPolicy service.

API for working with the system policy.

Inherits

Object

Includes

Google::Cloud::BinaryAuthorization::V1::SystemPolicy::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the SystemPolicy Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all SystemPolicy clients
::Google::Cloud::BinaryAuthorization::V1::SystemPolicy::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the SystemPolicy 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 Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#get_system_policy

def get_system_policy(request, options = nil) -> ::Google::Cloud::BinaryAuthorization::V1::Policy
def get_system_policy(name: nil) -> ::Google::Cloud::BinaryAuthorization::V1::Policy

Gets the current system policy in the specified location.

Overloads

def get_system_policy(request, options = nil) -> ::Google::Cloud::BinaryAuthorization::V1::Policy

Pass arguments to get_system_policy via a request object, either of type GetSystemPolicyRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::BinaryAuthorization::V1::GetSystemPolicyRequest, ::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.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_system_policy(name: nil) -> ::Google::Cloud::BinaryAuthorization::V1::Policy

Pass arguments to get_system_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).

Parameter

name (::String) — Required. The resource name, in the format locations/*/policy. Note that the system policy is not associated with a project.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::BinaryAuthorization::V1::Policy)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::BinaryAuthorization::V1::Policy)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#initialize

def initialize() { |config| ... } -> Client

Create a new SystemPolicy REST client object.

Yields

(config) — Configure the SystemPolicy client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

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

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