Policy Simulator v1 API - Class SimulatorClientImpl (1.2.0)

public sealed class SimulatorClientImpl : SimulatorClient

Reference documentation and code samples for the Policy Simulator v1 API class SimulatorClientImpl.

Simulator client wrapper implementation, for convenient use.

Inheritance

object > SimulatorClient > SimulatorClientImpl

Namespace

Google.Cloud.PolicySimulator.V1

Assembly

Google.Cloud.PolicySimulator.V1.dll

Remarks

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.

Constructors

SimulatorClientImpl(SimulatorClient, SimulatorSettings, ILogger)

public SimulatorClientImpl(Simulator.SimulatorClient grpcClient, SimulatorSettings settings, ILogger logger)

Constructs a client wrapper for the Simulator service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient SimulatorSimulatorClient

The underlying gRPC client.
settings SimulatorSettings

The base SimulatorSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateReplayOperationsClient

public override OperationsClient CreateReplayOperationsClient { get; }

The long-running operations client for CreateReplay.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Simulator.SimulatorClient GrpcClient { get; }

The underlying gRPC Simulator client

Property Value
Type Description
SimulatorSimulatorClient
Overrides

Methods

CreateReplay(CreateReplayRequest, CallSettings)

public override Operation<Replay, ReplayOperationMetadata> CreateReplay(CreateReplayRequest request, CallSettings callSettings = null)

Creates and starts a [Replay][google.cloud.policysimulator.v1.Replay] using the given [ReplayConfig][google.cloud.policysimulator.v1.ReplayConfig].

Parameters
Name Description
request CreateReplayRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationReplayReplayOperationMetadata

The RPC response.
Overrides

CreateReplayAsync(CreateReplayRequest, CallSettings)

public override Task<Operation<Replay, ReplayOperationMetadata>> CreateReplayAsync(CreateReplayRequest request, CallSettings callSettings = null)

Creates and starts a [Replay][google.cloud.policysimulator.v1.Replay] using the given [ReplayConfig][google.cloud.policysimulator.v1.ReplayConfig].

Parameters
Name Description
request CreateReplayRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationReplayReplayOperationMetadata

A Task containing the RPC response.
Overrides

GetReplay(GetReplayRequest, CallSettings)

public override Replay GetReplay(GetReplayRequest request, CallSettings callSettings = null)

Gets the specified [Replay][google.cloud.policysimulator.v1.Replay]. Each Replay is available for at least 7 days.

Parameters
Name Description
request GetReplayRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Replay

The RPC response.
Overrides

GetReplayAsync(GetReplayRequest, CallSettings)

public override Task<Replay> GetReplayAsync(GetReplayRequest request, CallSettings callSettings = null)

Gets the specified [Replay][google.cloud.policysimulator.v1.Replay]. Each Replay is available for at least 7 days.

Parameters
Name Description
request GetReplayRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskReplay

A Task containing the RPC response.
Overrides

ListReplayResults(ListReplayResultsRequest, CallSettings)

public override PagedEnumerable<ListReplayResultsResponse, ReplayResult> ListReplayResults(ListReplayResultsRequest request, CallSettings callSettings = null)

Lists the results of running a [Replay][google.cloud.policysimulator.v1.Replay].

Parameters
Name Description
request ListReplayResultsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListReplayResultsResponseReplayResult

A pageable sequence of ReplayResult resources.
Overrides

ListReplayResultsAsync(ListReplayResultsRequest, CallSettings)

public override PagedAsyncEnumerable<ListReplayResultsResponse, ReplayResult> ListReplayResultsAsync(ListReplayResultsRequest request, CallSettings callSettings = null)

Lists the results of running a [Replay][google.cloud.policysimulator.v1.Replay].

Parameters
Name Description
request ListReplayResultsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListReplayResultsResponseReplayResult

A pageable asynchronous sequence of ReplayResult resources.
Overrides