Class SystemPolicyV1Client (2.18.0)

API for working with the system 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

SystemPolicyV1Client(SystemPolicyV1Client const &)

Copy and move support

Parameter
NameDescription
SystemPolicyV1Client const &

SystemPolicyV1Client(SystemPolicyV1Client &&)

Copy and move support

Parameter
NameDescription
SystemPolicyV1Client &&

SystemPolicyV1Client(std::shared_ptr< SystemPolicyV1Connection >, Options)

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

Operators

operator=(SystemPolicyV1Client const &)

Copy and move support

Parameter
NameDescription
SystemPolicyV1Client const &
Returns
TypeDescription
SystemPolicyV1Client &

operator=(SystemPolicyV1Client &&)

Copy and move support

Parameter
NameDescription
SystemPolicyV1Client &&
Returns
TypeDescription
SystemPolicyV1Client &

Functions

GetSystemPolicy(std::string const &, Options)

Gets the current system policy in the specified location.

Parameters
NameDescription
name std::string const &

Required. The resource name, in the format locations/*/policy. Note that the system policy is not associated with a project.

opts Options

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

Returns
TypeDescription
StatusOr< google::cloud::binaryauthorization::v1::Policy >

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

GetSystemPolicy(google::cloud::binaryauthorization::v1::GetSystemPolicyRequest const &, Options)

Gets the current system policy in the specified location.

Parameters
NameDescription
request google::cloud::binaryauthorization::v1::GetSystemPolicyRequest 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.binaryauthorization.v1.GetSystemPolicyRequest. 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::binaryauthorization::v1::Policy >

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