Binary Authorization V1 API - Class Google::Cloud::BinaryAuthorization::V1::SystemPolicy::Client (v1.0.1)

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

Client for the SystemPolicy service.

API for working with the system policy.

Inherits

  • Object

Includes

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
Returns
Example 
# Modify the configuration for all SystemPolicy clients
::Google::Cloud::BinaryAuthorization::V1::SystemPolicy::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
Returns

#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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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::SystemPolicy::Client.new

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

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

# The returned object is of type Google::Cloud::BinaryAuthorization::V1::Policy.
p result

#initialize

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

Create a new SystemPolicy client object.

Yields
  • (config) — Configure the SystemPolicy client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::BinaryAuthorization::V1::SystemPolicy::Client.new

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)