Policy Simulator API - Module Google::Cloud::PolicySimulator (v1.3.0)

Reference documentation and code samples for the Policy Simulator API module Google::Cloud::PolicySimulator.

Configure the google-cloud-policy_simulator 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.

Create a new client object for OrgPolicyViolationsPreviewService.

By default, this returns an instance of Google::Cloud::PolicySimulator::V1::OrgPolicyViolationsPreviewService::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 OrgPolicyViolationsPreviewService 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 OrgPolicyViolationsPreviewService service. You can determine whether the method will succeed by calling PolicySimulator.org_policy_violations_preview_service_available?.

About OrgPolicyViolationsPreviewService

Violations Preview API service for OrgPolicy.

An OrgPolicyViolationsPreview is a preview of the violations that will exist as soon as a proposed OrgPolicy change is submitted. To create an OrgPolicyViolationsPreview, the API user specifies the changes they wish to make and requests the generation of a preview via [GenerateViolationsPreview][]. the OrgPolicy Simulator service then scans the API user's currently existing resources to determine these resources violate the newly set OrgPolicy.

Determines whether the OrgPolicyViolationsPreviewService service is supported by the current client. If true, you can retrieve a client object by calling PolicySimulator.org_policy_violations_preview_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the OrgPolicyViolationsPreviewService service, or if the versioned client gem needs an update to support the OrgPolicyViolationsPreviewService service.

Create a new client object for Simulator.

By default, this returns an instance of Google::Cloud::PolicySimulator::V1::Simulator::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 Simulator 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 Simulator service. You can determine whether the method will succeed by calling PolicySimulator.simulator_available?.

About Simulator

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.

Determines whether the Simulator service is supported by the current client. If true, you can retrieve a client object by calling PolicySimulator.simulator. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Simulator service, or if the versioned client gem needs an update to support the Simulator service.

value: "1.3.0"