GatewayControl is the control plane API for Connect Gateway.
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
GatewayControlClient(GatewayControlClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
GatewayControlClient const &
|
GatewayControlClient(GatewayControlClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
GatewayControlClient &&
|
GatewayControlClient(std::shared_ptr< GatewayControlConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< GatewayControlConnection >
|
opts |
Options
|
Operators
operator=(GatewayControlClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
GatewayControlClient const &
|
| Returns | |
|---|---|
| Type | Description |
GatewayControlClient & |
|
operator=(GatewayControlClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
GatewayControlClient &&
|
| Returns | |
|---|---|
| Type | Description |
GatewayControlClient & |
|
Functions
GenerateCredentials(google::cloud::gkeconnect::gateway::v1::GenerateCredentialsRequest const &, Options)
GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::gkeconnect::gateway::v1::GenerateCredentialsRequest 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::gkeconnect::gateway::v1::GenerateCredentialsResponse > |
the result of the RPC. The response message type (google.cloud.gkeconnect.gateway.v1.GenerateCredentialsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |