API Overview:
The beyondcorp.googleapis.com
service implements the Google Cloud BeyondCorp API.
Data Model:
The AppConnectionsService exposes the following resources:
- AppConnections, named as follows:
projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}
.
The AppConnectionsService service provides methods to manage (create/read/update/delete) BeyondCorp AppConnections.
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
AppConnectionsServiceClient(AppConnectionsServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppConnectionsServiceClient const &
|
AppConnectionsServiceClient(AppConnectionsServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppConnectionsServiceClient &&
|
AppConnectionsServiceClient(std::shared_ptr< AppConnectionsServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< AppConnectionsServiceConnection >
|
opts |
Options
|
Operators
operator=(AppConnectionsServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppConnectionsServiceClient const &
|
Returns | |
---|---|
Type | Description |
AppConnectionsServiceClient & |
operator=(AppConnectionsServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppConnectionsServiceClient &&
|
Returns | |
---|---|
Type | Description |
AppConnectionsServiceClient & |
Functions
ListAppConnections(std::string const &, Options)
Lists AppConnections in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the AppConnection 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::appconnections::v1::AppConnection > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAppConnections(google::cloud::beyondcorp::appconnections::v1::ListAppConnectionsRequest, Options)
Lists AppConnections in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::beyondcorp::appconnections::v1::ListAppConnectionsRequest
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::appconnections::v1::AppConnection > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetAppConnection(std::string const &, Options)
Gets details of a single AppConnection.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. BeyondCorp AppConnection 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::appconnections::v1::AppConnection > | the result of the RPC. The response message type (google.cloud.beyondcorp.appconnections.v1.AppConnection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAppConnection(google::cloud::beyondcorp::appconnections::v1::GetAppConnectionRequest const &, Options)
Gets details of a single AppConnection.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::beyondcorp::appconnections::v1::GetAppConnectionRequest 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::appconnections::v1::AppConnection > | the result of the RPC. The response message type (google.cloud.beyondcorp.appconnections.v1.AppConnection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateAppConnection(std::string const &, google::cloud::beyondcorp::appconnections::v1::AppConnection const &, std::string const &, Options)
Creates a new AppConnection in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource project name of the AppConnection location using the form: |
app_connection |
google::cloud::beyondcorp::appconnections::v1::AppConnection const &
Required. A BeyondCorp AppConnection resource. |
app_connection_id |
std::string const &
Optional. User-settable AppConnection resource ID.
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::beyondcorp::appconnections::v1::AppConnection > > | A |
CreateAppConnection(google::cloud::beyondcorp::appconnections::v1::CreateAppConnectionRequest const &, Options)
Creates a new AppConnection in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::beyondcorp::appconnections::v1::CreateAppConnectionRequest 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::appconnections::v1::AppConnection > > | A |
UpdateAppConnection(google::cloud::beyondcorp::appconnections::v1::AppConnection const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single AppConnection.
Parameters | |
---|---|
Name | Description |
app_connection |
google::cloud::beyondcorp::appconnections::v1::AppConnection const &
Required. AppConnection message with updated fields. Only supported fields specified in update_mask are updated. |
update_mask |
google::protobuf::FieldMask const &
Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnection]:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::beyondcorp::appconnections::v1::AppConnection > > | A |
UpdateAppConnection(google::cloud::beyondcorp::appconnections::v1::UpdateAppConnectionRequest const &, Options)
Updates the parameters of a single AppConnection.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::beyondcorp::appconnections::v1::UpdateAppConnectionRequest 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::appconnections::v1::AppConnection > > | A |
DeleteAppConnection(std::string const &, Options)
Deletes a single AppConnection.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. BeyondCorp Connector 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::appconnections::v1::AppConnectionOperationMetadata > > | A |
DeleteAppConnection(google::cloud::beyondcorp::appconnections::v1::DeleteAppConnectionRequest const &, Options)
Deletes a single AppConnection.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::beyondcorp::appconnections::v1::DeleteAppConnectionRequest 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::appconnections::v1::AppConnectionOperationMetadata > > | A |
ResolveAppConnections(std::string const &, Options)
Resolves AppConnections details for a given AppConnector.
An internal method called by a connector to find AppConnections to connect to.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the AppConnection 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::appconnections::v1::ResolveAppConnectionsResponse::AppConnectionDetails > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ResolveAppConnections(google::cloud::beyondcorp::appconnections::v1::ResolveAppConnectionsRequest, Options)
Resolves AppConnections details for a given AppConnector.
An internal method called by a connector to find AppConnections to connect to.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::beyondcorp::appconnections::v1::ResolveAppConnectionsRequest
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::appconnections::v1::ResolveAppConnectionsResponse::AppConnectionDetails > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |