@Generated("by gapic-generator-java")
Package com.google.cloud.policysimulator.v1
The interfaces provided are listed below, along with usage samples.
======================= SimulatorClient =======================
Service Description: Policy Simulator API service.
Policy Simulator is a collection of endpoints for creating, running, and viewing a [Replay][google.cloud.policysimulator.v1.Replay]. A [Replay][google.cloud.policysimulator.v1.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][google.cloud.policysimulator.v1.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.
Sample for SimulatorClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SimulatorClient simulatorClient = SimulatorClient.create()) {
ReplayName name =
ReplayName.ofProjectLocationReplayName("[PROJECT]", "[LOCATION]", "[REPLAY]");
Replay response = simulatorClient.getReplay(name);
}
-
Class Summary Class Description AccessStateDiff A summary and comparison of the principal's access under the current (baseline) policies and the proposed (simulated) policies for a single access tuple.AccessStateDiff.Builder A summary and comparison of the principal's access under the current (baseline) policies and the proposed (simulated) policies for a single access tuple.AccessTuple Information about the principal, resource, and permission to check.AccessTuple.Builder Information about the principal, resource, and permission to check.BindingExplanation Details about how a binding in a policy affects a principal's ability to use a permission.BindingExplanation.AnnotatedMembership Details about whether the binding includes the principal.BindingExplanation.AnnotatedMembership.Builder Details about whether the binding includes the principal.BindingExplanation.Builder Details about how a binding in a policy affects a principal's ability to use a permission.CreateReplayRequest Request message for [Simulator.CreateReplay][google.cloud.policysimulator.v1.Simulator.CreateReplay].CreateReplayRequest.Builder Request message for [Simulator.CreateReplay][google.cloud.policysimulator.v1.Simulator.CreateReplay].ExplainedAccess Details about how a set of policies, listed in [ExplainedPolicy][google.cloud.policysimulator.v1.ExplainedPolicy], resulted in a certain [AccessState][google.cloud.policysimulator.v1.AccessState] when replaying an access tuple.ExplainedAccess.Builder Details about how a set of policies, listed in [ExplainedPolicy][google.cloud.policysimulator.v1.ExplainedPolicy], resulted in a certain [AccessState][google.cloud.policysimulator.v1.AccessState] when replaying an access tuple.ExplainedPolicy Details about how a specific IAM [Policy][google.iam.v1.Policy] contributed to the access check.ExplainedPolicy.Builder Details about how a specific IAM [Policy][google.iam.v1.Policy] contributed to the access check.ExplanationsProto GetReplayRequest Request message for [Simulator.GetReplay][google.cloud.policysimulator.v1.Simulator.GetReplay].GetReplayRequest.Builder Request message for [Simulator.GetReplay][google.cloud.policysimulator.v1.Simulator.GetReplay].ListReplayResultsRequest Request message for [Simulator.ListReplayResults][google.cloud.policysimulator.v1.Simulator.ListReplayResults].ListReplayResultsRequest.Builder Request message for [Simulator.ListReplayResults][google.cloud.policysimulator.v1.Simulator.ListReplayResults].ListReplayResultsResponse Response message for [Simulator.ListReplayResults][google.cloud.policysimulator.v1.Simulator.ListReplayResults].ListReplayResultsResponse.Builder Response message for [Simulator.ListReplayResults][google.cloud.policysimulator.v1.Simulator.ListReplayResults].Replay A resource describing a `Replay`, or simulation.Replay.Builder A resource describing a `Replay`, or simulation.Replay.ResultsSummary Summary statistics about the replayed log entries.Replay.ResultsSummary.Builder Summary statistics about the replayed log entries.ReplayConfig The configuration used for a [Replay][google.cloud.policysimulator.v1.Replay].ReplayConfig.Builder The configuration used for a [Replay][google.cloud.policysimulator.v1.Replay].ReplayDiff The difference between the results of evaluating an access tuple under the current (baseline) policies and under the proposed (simulated) policies.ReplayDiff.Builder The difference between the results of evaluating an access tuple under the current (baseline) policies and under the proposed (simulated) policies.ReplayName ReplayName.Builder Builder for projects/{project}/locations/{location}/replays/{replay}.ReplayName.FolderLocationReplayBuilder Builder for folders/{folder}/locations/{location}/replays/{replay}.ReplayName.OrganizationLocationReplayBuilder Builder for organizations/{organization}/locations/{location}/replays/{replay}.ReplayOperationMetadata Metadata about a Replay operation.ReplayOperationMetadata.Builder Metadata about a Replay operation.ReplayResult The result of replaying a single access tuple against a simulated state.ReplayResult.Builder The result of replaying a single access tuple against a simulated state.SimulatorClient Service Description: Policy Simulator API service.SimulatorClient.ListReplayResultsFixedSizeCollection SimulatorClient.ListReplayResultsPage SimulatorClient.ListReplayResultsPagedResponse SimulatorGrpc Policy Simulator API service.SimulatorGrpc.SimulatorBlockingStub A stub to allow clients to do synchronous rpc calls to service Simulator.SimulatorGrpc.SimulatorFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service Simulator.SimulatorGrpc.SimulatorImplBase Base class for the server implementation of the service Simulator.SimulatorGrpc.SimulatorStub A stub to allow clients to do asynchronous rpc calls to service Simulator.SimulatorProto SimulatorSettings Settings class to configure an instance ofSimulatorClient
.SimulatorSettings.Builder Builder for SimulatorSettings. -
Enum Summary Enum Description AccessState Whether a principal has a permission for a resource.AccessStateDiff.AccessChangeType How the principal's access, specified in the AccessState field, changed between the current (baseline) policies and proposed (simulated) policies.BindingExplanation.Membership Whether the binding includes the principal.BindingExplanation.RolePermission Whether a role includes a specific permission.HeuristicRelevance The extent to which a single data point, such as the existence of a binding or whether a binding includes a specific principal, contributes to an overall determination.Replay.State The current state of the [Replay][google.cloud.policysimulator.v1.Replay].ReplayConfig.LogSource The source of the logs to use for a [Replay][google.cloud.policysimulator.v1.Replay].ReplayResult.ResultCase