Class SimulatorClient (2.20.0-rc)

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.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

SimulatorClient(SimulatorClient const &)

Copy and move support

Parameter
NameDescription
SimulatorClient const &

SimulatorClient(SimulatorClient &&)

Copy and move support

Parameter
NameDescription
SimulatorClient &&

SimulatorClient(std::shared_ptr< SimulatorConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< SimulatorConnection >
opts Options

Operators

operator=(SimulatorClient const &)

Copy and move support

Parameter
NameDescription
SimulatorClient const &
Returns
TypeDescription
SimulatorClient &

operator=(SimulatorClient &&)

Copy and move support

Parameter
NameDescription
SimulatorClient &&
Returns
TypeDescription
SimulatorClient &

Functions

GetReplay(std::string const &, Options)

Gets the specified Replay.

Each Replay is available for at least 7 days.

Parameters
NameDescription
name std::string const &

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

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::policysimulator::v1::Replay >

the result of the RPC. The response message type (google.cloud.policysimulator.v1.Replay) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetReplay(google::cloud::policysimulator::v1::GetReplayRequest const &, Options)

Gets the specified Replay.

Each Replay is available for at least 7 days.

Parameters
NameDescription
request google::cloud::policysimulator::v1::GetReplayRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.policysimulator.v1.GetReplayRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::policysimulator::v1::Replay >

the result of the RPC. The response message type (google.cloud.policysimulator.v1.Replay) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateReplay(std::string const &, google::cloud::policysimulator::v1::Replay const &, Options)

Creates and starts a Replay using the given ReplayConfig.

Parameters
NameDescription
parent std::string const &

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 const &

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

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::policysimulator::v1::Replay > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.policysimulator.v1.Replay proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateReplay(google::cloud::policysimulator::v1::CreateReplayRequest const &, Options)

Creates and starts a Replay using the given ReplayConfig.

Parameters
NameDescription
request google::cloud::policysimulator::v1::CreateReplayRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.policysimulator.v1.CreateReplayRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::policysimulator::v1::Replay > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.policysimulator.v1.Replay proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListReplayResults(std::string const &, Options)

Lists the results of running a Replay.

Parameters
NameDescription
parent std::string const &

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

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::policysimulator::v1::ReplayResult >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.policysimulator.v1.ReplayResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListReplayResults(google::cloud::policysimulator::v1::ListReplayResultsRequest, Options)

Lists the results of running a Replay.

Parameters
NameDescription
request google::cloud::policysimulator::v1::ListReplayResultsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.policysimulator.v1.ListReplayResultsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::policysimulator::v1::ReplayResult >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.policysimulator.v1.ReplayResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.