Class ClientGatewaysServiceClient (2.14.0)

Version 2.14.0

• 2.33.0-rc (latest)
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

API Overview:

The beyondcorp.googleapis.com service implements the Google Cloud BeyondCorp API.

Data Model:

The ClientGatewaysService exposes the following resources:

• Client Gateways, named as follows: projects/{project_id}/locations/{location_id}/clientGateways/{client_gateway_id}.

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

ClientGatewaysServiceClient(ClientGatewaysServiceClient const &)

Copy and move support

Parameter
Name	Description
	ClientGatewaysServiceClient const &

ClientGatewaysServiceClient(ClientGatewaysServiceClient &&)

Copy and move support

Parameter
Name	Description
	ClientGatewaysServiceClient &&

ClientGatewaysServiceClient(std::shared_ptr< ClientGatewaysServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< ClientGatewaysServiceConnection >
opts	Options

Operators

operator=(ClientGatewaysServiceClient const &)

Copy and move support

Parameter
Name	Description
	ClientGatewaysServiceClient const &

Returns
Type	Description
ClientGatewaysServiceClient &

operator=(ClientGatewaysServiceClient &&)

Copy and move support

Parameter
Name	Description
	ClientGatewaysServiceClient &&

Returns
Type	Description
ClientGatewaysServiceClient &

Functions

ListClientGateways(std::string const &, Options)

Lists ClientGateways in a given project and location.

Parameters
Name	Description
parent	std::string const & Required. Parent value for ListClientGatewaysRequest.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::beyondcorp::clientgateways::v1::ClientGateway >	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.clientgateways.v1.ClientGateway, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListClientGateways(google::cloud::beyondcorp::clientgateways::v1::ListClientGatewaysRequest, Options)

Lists ClientGateways in a given project and location.

Parameters
Name	Description
request	google::cloud::beyondcorp::clientgateways::v1::ListClientGatewaysRequest 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.clientgateways.v1.ListClientGatewaysRequest. 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
Type	Description
StreamRange< google::cloud::beyondcorp::clientgateways::v1::ClientGateway >	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.clientgateways.v1.ClientGateway, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetClientGateway(std::string const &, Options)

Gets details of a single ClientGateway.

Parameters
Name	Description
name	std::string const & Required. Name of the resource
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::beyondcorp::clientgateways::v1::ClientGateway >	the result of the RPC. The response message type (google.cloud.beyondcorp.clientgateways.v1.ClientGateway) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetClientGateway(google::cloud::beyondcorp::clientgateways::v1::GetClientGatewayRequest const &, Options)

Gets details of a single ClientGateway.

Parameters
Name	Description
request	google::cloud::beyondcorp::clientgateways::v1::GetClientGatewayRequest 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.clientgateways.v1.GetClientGatewayRequest. 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
Type	Description
StatusOr< google::cloud::beyondcorp::clientgateways::v1::ClientGateway >	the result of the RPC. The response message type (google.cloud.beyondcorp.clientgateways.v1.ClientGateway) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateClientGateway(std::string const &, google::cloud::beyondcorp::clientgateways::v1::ClientGateway const &, std::string const &, Options)

Creates a new ClientGateway in a given project and location.

Parameters
Name	Description
parent	std::string const & Required. Value for parent.
client_gateway	google::cloud::beyondcorp::clientgateways::v1::ClientGateway const & Required. The resource being created.
client_gateway_id	std::string const & Optional. User-settable client gateway 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
Type	Description
future< StatusOr< google::cloud::beyondcorp::clientgateways::v1::ClientGateway > >	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.clientgateways.v1.ClientGateway proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateClientGateway(google::cloud::beyondcorp::clientgateways::v1::CreateClientGatewayRequest const &, Options)

Creates a new ClientGateway in a given project and location.

Parameters
Name	Description
request	google::cloud::beyondcorp::clientgateways::v1::CreateClientGatewayRequest 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.clientgateways.v1.CreateClientGatewayRequest. 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
Type	Description
future< StatusOr< google::cloud::beyondcorp::clientgateways::v1::ClientGateway > >	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.clientgateways.v1.ClientGateway proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteClientGateway(std::string const &, Options)

Deletes a single ClientGateway.

Parameters
Name	Description
name	std::string const & Required. Name of the resource
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::beyondcorp::clientgateways::v1::ClientGatewayOperationMetadata > >	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.clientgateways.v1.ClientGatewayOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteClientGateway(google::cloud::beyondcorp::clientgateways::v1::DeleteClientGatewayRequest const &, Options)

Deletes a single ClientGateway.

Parameters
Name	Description
request	google::cloud::beyondcorp::clientgateways::v1::DeleteClientGatewayRequest 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.clientgateways.v1.DeleteClientGatewayRequest. 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
Type	Description
future< StatusOr< google::cloud::beyondcorp::clientgateways::v1::ClientGatewayOperationMetadata > >	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.clientgateways.v1.ClientGatewayOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.