Class ClientConnectorServicesServiceClient (2.14.0)

API Overview:

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

Data Model:

The ClientConnectorServicesService exposes the following resources:

  • Client Connector Services, named as follows: projects/{project_id}/locations/{location_id}/client_connector_services/{client_connector_service_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

ClientConnectorServicesServiceClient(ClientConnectorServicesServiceClient const &)

Copy and move support

Parameter
Name Description
ClientConnectorServicesServiceClient const &

ClientConnectorServicesServiceClient(ClientConnectorServicesServiceClient &&)

Copy and move support

Parameter
Name Description
ClientConnectorServicesServiceClient &&

ClientConnectorServicesServiceClient(std::shared_ptr< ClientConnectorServicesServiceConnection >, Options)

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

Operators

operator=(ClientConnectorServicesServiceClient const &)

Copy and move support

Parameter
Name Description
ClientConnectorServicesServiceClient const &
Returns
Type Description
ClientConnectorServicesServiceClient &

operator=(ClientConnectorServicesServiceClient &&)

Copy and move support

Parameter
Name Description
ClientConnectorServicesServiceClient &&
Returns
Type Description
ClientConnectorServicesServiceClient &

Functions

ListClientConnectorServices(std::string const &, Options)

Lists ClientConnectorServices in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListClientConnectorServicesRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::beyondcorp::clientconnectorservices::v1::ClientConnectorService >

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

ListClientConnectorServices(google::cloud::beyondcorp::clientconnectorservices::v1::ListClientConnectorServicesRequest, Options)

Lists ClientConnectorServices in a given project and location.

Parameters
Name Description
request google::cloud::beyondcorp::clientconnectorservices::v1::ListClientConnectorServicesRequest

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.clientconnectorservices.v1.ListClientConnectorServicesRequest. 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::clientconnectorservices::v1::ClientConnectorService >

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

GetClientConnectorService(std::string const &, Options)

Gets details of a single ClientConnectorService.

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::clientconnectorservices::v1::ClientConnectorService >

the result of the RPC. The response message type (google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetClientConnectorService(google::cloud::beyondcorp::clientconnectorservices::v1::GetClientConnectorServiceRequest const &, Options)

Gets details of a single ClientConnectorService.

Parameters
Name Description
request google::cloud::beyondcorp::clientconnectorservices::v1::GetClientConnectorServiceRequest 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.clientconnectorservices.v1.GetClientConnectorServiceRequest. 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::clientconnectorservices::v1::ClientConnectorService >

the result of the RPC. The response message type (google.cloud.beyondcorp.clientconnectorservices.v1.ClientConnectorService) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateClientConnectorService(std::string const &, google::cloud::beyondcorp::clientconnectorservices::v1::ClientConnectorService const &, std::string const &, Options)

Creates a new ClientConnectorService in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

client_connector_service google::cloud::beyondcorp::clientconnectorservices::v1::ClientConnectorService const &

Required. The resource being created.

client_connector_service_id std::string const &

Optional. User-settable client connector service 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.
    A random system generated name will be assigned if not specified by the user.
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::beyondcorp::clientconnectorservices::v1::ClientConnectorService > >

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

CreateClientConnectorService(google::cloud::beyondcorp::clientconnectorservices::v1::CreateClientConnectorServiceRequest const &, Options)

Creates a new ClientConnectorService in a given project and location.

Parameters
Name Description
request google::cloud::beyondcorp::clientconnectorservices::v1::CreateClientConnectorServiceRequest 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.clientconnectorservices.v1.CreateClientConnectorServiceRequest. 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::clientconnectorservices::v1::ClientConnectorService > >

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

UpdateClientConnectorService(google::cloud::beyondcorp::clientconnectorservices::v1::ClientConnectorService const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ClientConnectorService.

Parameters
Name Description
client_connector_service google::cloud::beyondcorp::clientconnectorservices::v1::ClientConnectorService const &

Required. The resource being updated.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the ClientConnectorService resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Mutable fields: display_name.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::beyondcorp::clientconnectorservices::v1::ClientConnectorService > >

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

UpdateClientConnectorService(google::cloud::beyondcorp::clientconnectorservices::v1::UpdateClientConnectorServiceRequest const &, Options)

Updates the parameters of a single ClientConnectorService.

Parameters
Name Description
request google::cloud::beyondcorp::clientconnectorservices::v1::UpdateClientConnectorServiceRequest 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.clientconnectorservices.v1.UpdateClientConnectorServiceRequest. 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::clientconnectorservices::v1::ClientConnectorService > >

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

DeleteClientConnectorService(std::string const &, Options)

Deletes a single ClientConnectorService.

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::clientconnectorservices::v1::ClientConnectorServiceOperationMetadata > >

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

DeleteClientConnectorService(google::cloud::beyondcorp::clientconnectorservices::v1::DeleteClientConnectorServiceRequest const &, Options)

Deletes a single ClientConnectorService.

Parameters
Name Description
request google::cloud::beyondcorp::clientconnectorservices::v1::DeleteClientConnectorServiceRequest 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.clientconnectorservices.v1.DeleteClientConnectorServiceRequest. 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::clientconnectorservices::v1::ClientConnectorServiceOperationMetadata > >

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