Class AppGatewaysServiceClient (2.21.0-rc)

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

AppGatewaysServiceClient(AppGatewaysServiceClient &&)

Copy and move support

Parameter
NameDescription
AppGatewaysServiceClient &&

AppGatewaysServiceClient(std::shared_ptr< AppGatewaysServiceConnection >, Options)

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

Operators

operator=(AppGatewaysServiceClient const &)

Copy and move support

Parameter
NameDescription
AppGatewaysServiceClient const &
Returns
TypeDescription
AppGatewaysServiceClient &

operator=(AppGatewaysServiceClient &&)

Copy and move support

Parameter
NameDescription
AppGatewaysServiceClient &&
Returns
TypeDescription
AppGatewaysServiceClient &

Functions

ListAppGateways(std::string const &, Options)

Lists AppGateways in a given project and location.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the AppGateway 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::appgateways::v1::AppGateway >

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.appgateways.v1.AppGateway, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAppGateways(google::cloud::beyondcorp::appgateways::v1::ListAppGatewaysRequest, Options)

Lists AppGateways in a given project and location.

Parameters
NameDescription
request google::cloud::beyondcorp::appgateways::v1::ListAppGatewaysRequest

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.appgateways.v1.ListAppGatewaysRequest. 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::appgateways::v1::AppGateway >

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.appgateways.v1.AppGateway, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetAppGateway(std::string const &, Options)

Gets details of a single AppGateway.

Parameters
NameDescription
name std::string const &

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}

opts Options

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

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

GetAppGateway(google::cloud::beyondcorp::appgateways::v1::GetAppGatewayRequest const &, Options)

Gets details of a single AppGateway.

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

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

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

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.

  • 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::appgateways::v1::AppGateway > >

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.appgateways.v1.AppGateway proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAppGateway(google::cloud::beyondcorp::appgateways::v1::CreateAppGatewayRequest const &, Options)

Creates a new AppGateway in a given project and location.

Parameters
NameDescription
request google::cloud::beyondcorp::appgateways::v1::CreateAppGatewayRequest 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.appgateways.v1.CreateAppGatewayRequest. 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::appgateways::v1::AppGateway > >

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.appgateways.v1.AppGateway proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAppGateway(std::string const &, Options)

Deletes a single AppGateway.

Parameters
NameDescription
name std::string const &

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::beyondcorp::appgateways::v1::AppGatewayOperationMetadata > >

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.appgateways.v1.AppGatewayOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAppGateway(google::cloud::beyondcorp::appgateways::v1::DeleteAppGatewayRequest const &, Options)

Deletes a single AppGateway.

Parameters
NameDescription
request google::cloud::beyondcorp::appgateways::v1::DeleteAppGatewayRequest 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.appgateways.v1.DeleteAppGatewayRequest. 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::appgateways::v1::AppGatewayOperationMetadata > >

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.appgateways.v1.AppGatewayOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.