Class: Google::Cloud::PolicySimulator::V1::Simulator::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/policy_simulator/v1/simulator/client.rb

Overview

Client for the Simulator service.

Policy Simulator API service.

Policy Simulator is a collection of endpoints for creating, running, and viewing a Replay. A Replay is a type of simulation that lets you see how your principals' access to resources might change if you changed your IAM policy.

During a Replay, Policy Simulator re-evaluates, or replays, past access attempts under both the current policy and your proposed policy, and compares those results to determine how your principals' access might change under the proposed policy.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#replay_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Simulator client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the Simulator client.

Yield Parameters:



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/google/cloud/policy_simulator/v1/simulator/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/policysimulator/v1/simulator_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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @simulator_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::PolicySimulator::V1::Simulator::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::PolicySimulator::V1::Simulator::Operations (readonly)

Get the associated client for long-running operations.

Returns:



199
200
201
 
# File 'lib/google/cloud/policy_simulator/v1/simulator/client.rb', line 199

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Simulator Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/policy_simulator/v1/simulator/client.rb', line 73

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "PolicySimulator", "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_replay.timeout = 60.0
    default_config.rpcs.get_replay.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_replay.timeout = 60.0

    default_config.rpcs.list_replay_results.timeout = 60.0
    default_config.rpcs.list_replay_results.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the Simulator 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



117
118
119
120
 
# File 'lib/google/cloud/policy_simulator/v1/simulator/client.rb', line 117

def configure
  yield @config if block_given?
  @config
end

#create_replay(request, options = nil) ⇒ ::Gapic::Operation #create_replay(parent: nil, replay: nil) ⇒ ::Gapic::Operation

Creates and starts a Replay using the given ReplayConfig.

Examples:

Basic example

require "google/cloud/policy_simulator/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PolicySimulator::V1::Simulator::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_replay(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::PolicySimulator::V1::CreateReplayRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_replay(parent: nil, replay: nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource where this Replay will be created. This resource must be a project, folder, or organization with a location.

      Example: projects/my-example-project/locations/global

    • replay (::Google::Cloud::PolicySimulator::V1::Replay, ::Hash) (defaults to: nil) —

      Required. The Replay to create. Set Replay.ReplayConfig to configure the replay.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/google/cloud/policy_simulator/v1/simulator/client.rb', line 357

def create_replay request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PolicySimulator::V1::CreateReplayRequest

  # 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_replay.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::PolicySimulator::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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_replay.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_replay.retry_policy

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

  @simulator_stub.call_rpc :create_replay, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_replay(request, options = nil) ⇒ ::Google::Cloud::PolicySimulator::V1::Replay #get_replay(name: nil) ⇒ ::Google::Cloud::PolicySimulator::V1::Replay

Gets the specified Replay. Each Replay is available for at least 7 days.

Examples:

Basic example

require "google/cloud/policy_simulator/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PolicySimulator::V1::Simulator::Client.new

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

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

# The returned object is of type Google::Cloud::PolicySimulator::V1::Replay.
p result

Overloads:

  • #get_replay(request, options = nil) ⇒ ::Google::Cloud::PolicySimulator::V1::Replay

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

    Parameters:

    • request (::Google::Cloud::PolicySimulator::V1::GetReplayRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_replay(name: nil) ⇒ ::Google::Cloud::PolicySimulator::V1::Replay

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

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the Replay to retrieve, in the following format:

      {projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}, where {resource-id} is the ID of the project, folder, or organization that owns the Replay.

      Example: projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/google/cloud/policy_simulator/v1/simulator/client.rb', line 256

def get_replay request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PolicySimulator::V1::GetReplayRequest

  # 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_replay.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::PolicySimulator::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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_replay.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_replay.retry_policy

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

  @simulator_stub.call_rpc :get_replay, 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_replay_results(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PolicySimulator::V1::ReplayResult> #list_replay_results(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PolicySimulator::V1::ReplayResult>

Lists the results of running a Replay.

Examples:

Basic example

require "google/cloud/policy_simulator/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PolicySimulator::V1::Simulator::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::PolicySimulator::V1::ReplayResult.
  p item
end

Overloads:

  • #list_replay_results(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PolicySimulator::V1::ReplayResult>

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

    Parameters:

    • request (::Google::Cloud::PolicySimulator::V1::ListReplayResultsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_replay_results(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PolicySimulator::V1::ReplayResult>

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

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The Replay whose results are listed, in the following format:

      {projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}

      Example: projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of ReplayResult objects to return. Defaults to 5000.

      The maximum value is 5000; values above 5000 are rounded down to 5000.

    • page_token (::String) (defaults to: nil) —

      A page token, received from a previous Simulator.ListReplayResults call. Provide this token to retrieve the next page of results.

      When paginating, all other parameters provided to [Simulator.ListReplayResults[] must match the call that provided the page token.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/google/cloud/policy_simulator/v1/simulator/client.rb', line 469

def list_replay_results request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PolicySimulator::V1::ListReplayResultsRequest

  # 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_replay_results.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::PolicySimulator::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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_replay_results.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_replay_results.retry_policy

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

  @simulator_stub.call_rpc :list_replay_results, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @simulator_stub, :list_replay_results, 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


127
128
129
 
# File 'lib/google/cloud/policy_simulator/v1/simulator/client.rb', line 127

def universe_domain
  @simulator_stub.universe_domain
end