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 | |
---|---|
Name | Description |
|
SimulatorClient const &
|
SimulatorClient(SimulatorClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SimulatorClient &&
|
SimulatorClient(std::shared_ptr< SimulatorConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< SimulatorConnection >
|
opts |
Options
|
Operators
operator=(SimulatorClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SimulatorClient const &
|
Returns | |
---|---|
Type | Description |
SimulatorClient & |
operator=(SimulatorClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SimulatorClient &&
|
Returns | |
---|---|
Type | Description |
SimulatorClient & |
Functions
GetReplay(std::string const &, Options)
Gets the specified Replay.
Each Replay
is available for at least 7 days.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Replay to retrieve, in the following format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
GetReplay(google::cloud::policysimulator::v1::GetReplayRequest const &, Options)
Gets the specified Replay.
Each Replay
is available for at least 7 days.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::policysimulator::v1::GetReplayRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
CreateReplay(std::string const &, google::cloud::policysimulator::v1::Replay const &, Options)
Creates and starts a Replay using the given ReplayConfig.
Parameters | |
---|---|
Name | Description |
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. |
replay |
google::cloud::policysimulator::v1::Replay const &
Required. The Replay to create. Set |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::policysimulator::v1::Replay > > |
A |
CreateReplay(google::cloud::policysimulator::v1::CreateReplayRequest const &, Options)
Creates and starts a Replay using the given ReplayConfig.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::policysimulator::v1::CreateReplayRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::policysimulator::v1::Replay > > |
A |
ListReplayResults(std::string const &, Options)
Lists the results of running a Replay.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The Replay whose results are listed, in the following format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
ListReplayResults(google::cloud::policysimulator::v1::ListReplayResultsRequest, Options)
Lists the results of running a Replay.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::policysimulator::v1::ListReplayResultsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |