API Overview:
The beyondcorp.googleapis.com
service implements the Google Cloud BeyondCorp API.
Data Model:
The AppGatewaysService exposes the following resources:
- AppGateways, named as follows:
projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
.
The AppGatewaysService service provides methods to manage (create/read/update/delete) BeyondCorp AppGateways.
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
AppGatewaysServiceClient(AppGatewaysServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppGatewaysServiceClient const &
|
AppGatewaysServiceClient(AppGatewaysServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppGatewaysServiceClient &&
|
AppGatewaysServiceClient(std::shared_ptr< AppGatewaysServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< AppGatewaysServiceConnection >
|
opts |
Options
|
Operators
operator=(AppGatewaysServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppGatewaysServiceClient const &
|
Returns | |
---|---|
Type | Description |
AppGatewaysServiceClient & |
operator=(AppGatewaysServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppGatewaysServiceClient &&
|
Returns | |
---|---|
Type | Description |
AppGatewaysServiceClient & |
Functions
ListAppGateways(std::string const &, Options)
Lists AppGateways in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the AppGateway location using the form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::beyondcorp::appgateways::v1::AppGateway > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAppGateways(google::cloud::beyondcorp::appgateways::v1::ListAppGatewaysRequest, Options)
Lists AppGateways in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::beyondcorp::appgateways::v1::ListAppGatewaysRequest
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::beyondcorp::appgateways::v1::AppGateway > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetAppGateway(std::string const &, Options)
Gets details of a single AppGateway.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. BeyondCorp AppGateway name using the form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::beyondcorp::appgateways::v1::AppGateway > |
the result of the RPC. The response message type (google.cloud.beyondcorp.appgateways.v1.AppGateway) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAppGateway(google::cloud::beyondcorp::appgateways::v1::GetAppGatewayRequest const &, Options)
Gets details of a single AppGateway.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::beyondcorp::appgateways::v1::GetAppGatewayRequest 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::beyondcorp::appgateways::v1::AppGateway > |
the result of the RPC. The response message type (google.cloud.beyondcorp.appgateways.v1.AppGateway) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateAppGateway(std::string const &, google::cloud::beyondcorp::appgateways::v1::AppGateway const &, std::string const &, Options)
Creates a new AppGateway in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource project name of the AppGateway location using the form: |
app_gateway |
google::cloud::beyondcorp::appgateways::v1::AppGateway const &
Required. A BeyondCorp AppGateway resource. |
app_gateway_id |
std::string const &
Optional. User-settable AppGateway resource ID.
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::beyondcorp::appgateways::v1::AppGateway > > |
A |
CreateAppGateway(NoAwaitTag, std::string const &, google::cloud::beyondcorp::appgateways::v1::AppGateway const &, std::string const &, Options)
Creates a new AppGateway in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
app_gateway |
google::cloud::beyondcorp::appgateways::v1::AppGateway const &
|
app_gateway_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateAppGateway(google::cloud::beyondcorp::appgateways::v1::CreateAppGatewayRequest const &, Options)
Creates a new AppGateway in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::beyondcorp::appgateways::v1::CreateAppGatewayRequest 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::beyondcorp::appgateways::v1::AppGateway > > |
A |
CreateAppGateway(NoAwaitTag, google::cloud::beyondcorp::appgateways::v1::CreateAppGatewayRequest const &, Options)
Creates a new AppGateway in a given project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::beyondcorp::appgateways::v1::CreateAppGatewayRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateAppGateway(google::longrunning::Operation const &, Options)
Creates a new AppGateway in a given project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::beyondcorp::appgateways::v1::AppGateway > > |
DeleteAppGateway(std::string const &, Options)
Deletes a single AppGateway.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. BeyondCorp AppGateway name using the form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::beyondcorp::appgateways::v1::AppGatewayOperationMetadata > > |
A |
DeleteAppGateway(NoAwaitTag, std::string const &, Options)
Deletes a single AppGateway.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteAppGateway(google::cloud::beyondcorp::appgateways::v1::DeleteAppGatewayRequest const &, Options)
Deletes a single AppGateway.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::beyondcorp::appgateways::v1::DeleteAppGatewayRequest 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::beyondcorp::appgateways::v1::AppGatewayOperationMetadata > > |
A |
DeleteAppGateway(NoAwaitTag, google::cloud::beyondcorp::appgateways::v1::DeleteAppGatewayRequest const &, Options)
Deletes a single AppGateway.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::beyondcorp::appgateways::v1::DeleteAppGatewayRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteAppGateway(google::longrunning::Operation const &, Options)
Deletes a single AppGateway.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::beyondcorp::appgateways::v1::AppGatewayOperationMetadata > > |