Package policysimulator is an auto-generated package for the Policy Simulator API.
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 members’ 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 members’ access might change under the proposed policy.
NOTE : This package is in beta . It is not stable , and may be subject to changes .
General documentation
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go .
Example usage
To get started with this package, create a client.
ctx := context . Background () // 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := policysimulator . NewSimulatorClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client.
ctx := context . Background () // 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := policysimulator . NewSimulatorClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & policysimulatorpb . GetReplayRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/policysimulator/apiv1/policysimulatorpb#GetReplayRequest. } resp , err := c . GetReplay ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Inspecting errors
To see examples of how to inspect errors returned by this package please reference [Inspecting errors]( https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors ).
Use of Context
The ctx passed to NewSimulatorClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CreateReplayOperation
type
CreateReplayOperation
struct
{
// contains filtered or unexported fields
}
CreateReplayOperation manages a long-running operation from CreateReplay.
func (*CreateReplayOperation) Done
func
(
op
*
CreateReplayOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateReplayOperation) Metadata
func
(
op
*
CreateReplayOperation
)
Metadata
()
(
*
policysimulatorpb
.
ReplayOperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateReplayOperation) Name
func
(
op
*
CreateReplayOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateReplayOperation) Poll
func
(
op
*
CreateReplayOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
policysimulatorpb
.
Replay
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateReplayOperation) Wait
func
(
op
*
CreateReplayOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
policysimulatorpb
.
Replay
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
OperationIterator
type
OperationIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
longrunningpb
.
Operation
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) Next
func
(
it
*
OperationIterator
)
Next
()
(
*
longrunningpb
.
Operation
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo
func
(
it
*
OperationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ReplayResultIterator
type
ReplayResultIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
policysimulatorpb
.
ReplayResult
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ReplayResultIterator manages a stream of *policysimulatorpb.ReplayResult.
func (*ReplayResultIterator) Next
func
(
it
*
ReplayResultIterator
)
Next
()
(
*
policysimulatorpb
.
ReplayResult
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ReplayResultIterator) PageInfo
func
(
it
*
ReplayResultIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
SimulatorCallOptions
type
SimulatorCallOptions
struct
{
GetReplay
[]
gax
.
CallOption
CreateReplay
[]
gax
.
CallOption
ListReplayResults
[]
gax
.
CallOption
GetOperation
[]
gax
.
CallOption
ListOperations
[]
gax
.
CallOption
}
SimulatorCallOptions contains the retry settings for each method of SimulatorClient.
SimulatorClient
type
SimulatorClient
struct
{
// The call options for this service.
CallOptions
*
SimulatorCallOptions
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient
*
lroauto
.
OperationsClient
// contains filtered or unexported fields
}
SimulatorClient is a client for interacting with Policy Simulator API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
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.
func NewSimulatorClient
func
NewSimulatorClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
SimulatorClient
,
error
)
NewSimulatorClient creates a new simulator client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
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.
Example
package
main
import
(
"context"
policysimulator
"cloud.google.com/go/policysimulator/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
policysimulator
.
NewSimulatorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewSimulatorRESTClient
func
NewSimulatorRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
SimulatorClient
,
error
)
NewSimulatorRESTClient creates a new simulator rest client.
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.
Example
package
main
import
(
"context"
policysimulator
"cloud.google.com/go/policysimulator/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
policysimulator
.
NewSimulatorRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*SimulatorClient) Close
func
(
c
*
SimulatorClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*SimulatorClient) Connection (deprecated)
func
(
c
*
SimulatorClient
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*SimulatorClient) CreateReplay
func
(
c
*
SimulatorClient
)
CreateReplay
(
ctx
context
.
Context
,
req
*
policysimulatorpb
.
CreateReplayRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateReplayOperation
,
error
)
CreateReplay creates and starts a Replay using the given ReplayConfig.
Example
package
main
import
(
"context"
policysimulator
"cloud.google.com/go/policysimulator/apiv1"
policysimulatorpb
"cloud.google.com/go/policysimulator/apiv1/policysimulatorpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
policysimulator
.
NewSimulatorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& policysimulatorpb
.
CreateReplayRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/policysimulator/apiv1/policysimulatorpb#CreateReplayRequest.
}
op
,
err
:=
c
.
CreateReplay
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*SimulatorClient) CreateReplayOperation
func
(
c
*
SimulatorClient
)
CreateReplayOperation
(
name
string
)
*
CreateReplayOperation
CreateReplayOperation returns a new CreateReplayOperation from a given name. The name must be that of a previously created CreateReplayOperation, possibly from a different process.
func (*SimulatorClient) GetOperation
func
(
c
*
SimulatorClient
)
GetOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
GetOperationRequest
,
opts
...
gax
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
GetOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
policysimulator
"cloud.google.com/go/policysimulator/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
policysimulator
.
NewSimulatorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
GetOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp
,
err
:=
c
.
GetOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*SimulatorClient) GetReplay
func
(
c
*
SimulatorClient
)
GetReplay
(
ctx
context
.
Context
,
req
*
policysimulatorpb
.
GetReplayRequest
,
opts
...
gax
.
CallOption
)
(
*
policysimulatorpb
.
Replay
,
error
)
GetReplay gets the specified Replay. Each Replay is available for at least 7 days.
Example
package
main
import
(
"context"
policysimulator
"cloud.google.com/go/policysimulator/apiv1"
policysimulatorpb
"cloud.google.com/go/policysimulator/apiv1/policysimulatorpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
policysimulator
.
NewSimulatorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& policysimulatorpb
.
GetReplayRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/policysimulator/apiv1/policysimulatorpb#GetReplayRequest.
}
resp
,
err
:=
c
.
GetReplay
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*SimulatorClient) ListOperations
func
(
c
*
SimulatorClient
)
ListOperations
(
ctx
context
.
Context
,
req
*
longrunningpb
.
ListOperationsRequest
,
opts
...
gax
.
CallOption
)
*
OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
policysimulator
"cloud.google.com/go/policysimulator/apiv1"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
policysimulator
.
NewSimulatorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
ListOperationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it
:=
c
.
ListOperations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*SimulatorClient) ListReplayResults
func
(
c
*
SimulatorClient
)
ListReplayResults
(
ctx
context
.
Context
,
req
*
policysimulatorpb
.
ListReplayResultsRequest
,
opts
...
gax
.
CallOption
)
*
ReplayResultIterator
ListReplayResults lists the results of running a Replay.
Example
package
main
import
(
"context"
policysimulator
"cloud.google.com/go/policysimulator/apiv1"
policysimulatorpb
"cloud.google.com/go/policysimulator/apiv1/policysimulatorpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
policysimulator
.
NewSimulatorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& policysimulatorpb
.
ListReplayResultsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/policysimulator/apiv1/policysimulatorpb#ListReplayResultsRequest.
}
it
:=
c
.
ListReplayResults
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
