Class AppConnectionsServiceClient (2.20.0-rc)

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
NameDescription
AppConnectionsServiceClient const &

AppConnectionsServiceClient(AppConnectionsServiceClient &&)

Copy and move support

Parameter
NameDescription
AppConnectionsServiceClient &&

AppConnectionsServiceClient(std::shared_ptr< AppConnectionsServiceConnection >, Options)

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

Operators

operator=(AppConnectionsServiceClient const &)

Copy and move support

Parameter
NameDescription
AppConnectionsServiceClient const &
Returns
TypeDescription
AppConnectionsServiceClient &

operator=(AppConnectionsServiceClient &&)

Copy and move support

Parameter
NameDescription
AppConnectionsServiceClient &&
Returns
TypeDescription
AppConnectionsServiceClient &

Functions

ListAppConnections(std::string const &, Options)

Lists AppConnections in a given project and location.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

opts Options

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

Returns
TypeDescription
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.beyondcorp.appconnections.v1.AppConnection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAppConnections(google::cloud::beyondcorp::appconnections::v1::ListAppConnectionsRequest, Options)

Lists AppConnections in a given project and location.

Parameters
NameDescription
request google::cloud::beyondcorp::appconnections::v1::ListAppConnectionsRequest

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.beyondcorp.appconnections.v1.ListAppConnectionsRequest. 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
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.beyondcorp.appconnections.v1.AppConnection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetAppConnection(std::string const &, Options)

Gets details of a single AppConnection.

Parameters
NameDescription
name std::string const &

Required. BeyondCorp AppConnection name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

opts Options

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

Returns
TypeDescription
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 StatusOr contains the error details.

GetAppConnection(google::cloud::beyondcorp::appconnections::v1::GetAppConnectionRequest const &, Options)

Gets details of a single AppConnection.

Parameters
NameDescription
request google::cloud::beyondcorp::appconnections::v1::GetAppConnectionRequest 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.beyondcorp.appconnections.v1.GetAppConnectionRequest. 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::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 StatusOr contains the error details.

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
NameDescription
parent std::string const &

Required. The resource project name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

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.

  • Must start with a letter.
  • Must contain between 4-63 characters from /[a-z][0-9]-/.
  • Must end with a number or a letter.
opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::beyondcorp::appconnections::v1::AppConnection > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.beyondcorp.appconnections.v1.AppConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAppConnection(google::cloud::beyondcorp::appconnections::v1::CreateAppConnectionRequest const &, Options)

Creates a new AppConnection in a given project and location.

Parameters
NameDescription
request google::cloud::beyondcorp::appconnections::v1::CreateAppConnectionRequest 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.beyondcorp.appconnections.v1.CreateAppConnectionRequest. 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
future< StatusOr< google::cloud::beyondcorp::appconnections::v1::AppConnection > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.beyondcorp.appconnections.v1.AppConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAppConnection(google::cloud::beyondcorp::appconnections::v1::AppConnection const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single AppConnection.

Parameters
NameDescription
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]:

  • labels
  • display_name
  • application_endpoint
  • connectors
opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::beyondcorp::appconnections::v1::AppConnection > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.beyondcorp.appconnections.v1.AppConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAppConnection(google::cloud::beyondcorp::appconnections::v1::UpdateAppConnectionRequest const &, Options)

Updates the parameters of a single AppConnection.

Parameters
NameDescription
request google::cloud::beyondcorp::appconnections::v1::UpdateAppConnectionRequest 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.beyondcorp.appconnections.v1.UpdateAppConnectionRequest. 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
future< StatusOr< google::cloud::beyondcorp::appconnections::v1::AppConnection > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.beyondcorp.appconnections.v1.AppConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAppConnection(std::string const &, Options)

Deletes a single AppConnection.

Parameters
NameDescription
name std::string const &

Required. BeyondCorp Connector name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::beyondcorp::appconnections::v1::AppConnectionOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.beyondcorp.appconnections.v1.AppConnectionOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAppConnection(google::cloud::beyondcorp::appconnections::v1::DeleteAppConnectionRequest const &, Options)

Deletes a single AppConnection.

Parameters
NameDescription
request google::cloud::beyondcorp::appconnections::v1::DeleteAppConnectionRequest 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.beyondcorp.appconnections.v1.DeleteAppConnectionRequest. 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
future< StatusOr< google::cloud::beyondcorp::appconnections::v1::AppConnectionOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.beyondcorp.appconnections.v1.AppConnectionOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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
NameDescription
parent std::string const &

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

opts Options

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

Returns
TypeDescription
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.AppConnectionDetails, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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
NameDescription
request google::cloud::beyondcorp::appconnections::v1::ResolveAppConnectionsRequest

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.beyondcorp.appconnections.v1.ResolveAppConnectionsRequest. 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
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.AppConnectionDetails, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.