Class NetworkServicesClient (2.30.0)

Service describing handlers for resources.

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

NetworkServicesClient(NetworkServicesClient const &)

Copy and move support

Parameter
Name Description
NetworkServicesClient const &

NetworkServicesClient(NetworkServicesClient &&)

Copy and move support

Parameter
Name Description
NetworkServicesClient &&

NetworkServicesClient(std::shared_ptr< NetworkServicesConnection >, Options)

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

Operators

operator=(NetworkServicesClient const &)

Copy and move support

Parameter
Name Description
NetworkServicesClient const &
Returns
Type Description
NetworkServicesClient &

operator=(NetworkServicesClient &&)

Copy and move support

Parameter
Name Description
NetworkServicesClient &&
Returns
Type Description
NetworkServicesClient &

Functions

ListEndpointPolicies(std::string const &, Options)

Lists EndpointPolicies in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the EndpointPolicies should be listed, specified in the format projects/*/locations/global.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networkservices::v1::EndpointPolicy >

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

ListEndpointPolicies(google::cloud::networkservices::v1::ListEndpointPoliciesRequest, Options)

Lists EndpointPolicies in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::ListEndpointPoliciesRequest

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.networkservices.v1.ListEndpointPoliciesRequest. 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::networkservices::v1::EndpointPolicy >

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

GetEndpointPolicy(std::string const &, Options)

Gets details of a single EndpointPolicy.

Parameters
Name Description
name std::string const &

Required. A name of the EndpointPolicy to get. Must be in the format projects/*/locations/global/endpointPolicies/*.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networkservices::v1::EndpointPolicy >

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

GetEndpointPolicy(google::cloud::networkservices::v1::GetEndpointPolicyRequest const &, Options)

Gets details of a single EndpointPolicy.

Parameters
Name Description
request google::cloud::networkservices::v1::GetEndpointPolicyRequest 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.networkservices.v1.GetEndpointPolicyRequest. 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::networkservices::v1::EndpointPolicy >

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

CreateEndpointPolicy(std::string const &, google::cloud::networkservices::v1::EndpointPolicy const &, std::string const &, Options)

Creates a new EndpointPolicy in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the EndpointPolicy. Must be in the format projects/*/locations/global.

endpoint_policy google::cloud::networkservices::v1::EndpointPolicy const &

Required. EndpointPolicy resource to be created.

endpoint_policy_id std::string const &

Required. Short name of the EndpointPolicy resource to be created. E.g. "CustomECS".

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::EndpointPolicy > >

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

CreateEndpointPolicy(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::EndpointPolicy const &, std::string const &, Options)

Creates a new EndpointPolicy in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
endpoint_policy google::cloud::networkservices::v1::EndpointPolicy const &
endpoint_policy_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateEndpointPolicy(google::cloud::networkservices::v1::CreateEndpointPolicyRequest const &, Options)

Creates a new EndpointPolicy in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::CreateEndpointPolicyRequest 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.networkservices.v1.CreateEndpointPolicyRequest. 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::networkservices::v1::EndpointPolicy > >

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

CreateEndpointPolicy(NoAwaitTag, google::cloud::networkservices::v1::CreateEndpointPolicyRequest const &, Options)

Creates a new EndpointPolicy in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::CreateEndpointPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateEndpointPolicy(google::longrunning::Operation const &, Options)

Creates a new EndpointPolicy in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::EndpointPolicy > >

UpdateEndpointPolicy(google::cloud::networkservices::v1::EndpointPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single EndpointPolicy.

Parameters
Name Description
endpoint_policy google::cloud::networkservices::v1::EndpointPolicy const &

Required. Updated EndpointPolicy resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy 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.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::EndpointPolicy > >

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

UpdateEndpointPolicy(NoAwaitTag, google::cloud::networkservices::v1::EndpointPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single EndpointPolicy.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
endpoint_policy google::cloud::networkservices::v1::EndpointPolicy const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateEndpointPolicy(google::cloud::networkservices::v1::UpdateEndpointPolicyRequest const &, Options)

Updates the parameters of a single EndpointPolicy.

Parameters
Name Description
request google::cloud::networkservices::v1::UpdateEndpointPolicyRequest 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.networkservices.v1.UpdateEndpointPolicyRequest. 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::networkservices::v1::EndpointPolicy > >

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

UpdateEndpointPolicy(NoAwaitTag, google::cloud::networkservices::v1::UpdateEndpointPolicyRequest const &, Options)

Updates the parameters of a single EndpointPolicy.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::UpdateEndpointPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateEndpointPolicy(google::longrunning::Operation const &, Options)

Updates the parameters of a single EndpointPolicy.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::EndpointPolicy > >

DeleteEndpointPolicy(std::string const &, Options)

Deletes a single EndpointPolicy.

Parameters
Name Description
name std::string const &

Required. A name of the EndpointPolicy to delete. Must be in the format projects/*/locations/global/endpointPolicies/*.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

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

DeleteEndpointPolicy(NoAwaitTag, std::string const &, Options)

Deletes a single EndpointPolicy.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteEndpointPolicy(google::cloud::networkservices::v1::DeleteEndpointPolicyRequest const &, Options)

Deletes a single EndpointPolicy.

Parameters
Name Description
request google::cloud::networkservices::v1::DeleteEndpointPolicyRequest 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.networkservices.v1.DeleteEndpointPolicyRequest. 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::networkservices::v1::OperationMetadata > >

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

DeleteEndpointPolicy(NoAwaitTag, google::cloud::networkservices::v1::DeleteEndpointPolicyRequest const &, Options)

Deletes a single EndpointPolicy.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::DeleteEndpointPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteEndpointPolicy(google::longrunning::Operation const &, Options)

Deletes a single EndpointPolicy.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

ListGateways(std::string const &, Options)

Lists Gateways in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the Gateways should be listed, specified in the format projects/*/locations/*.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networkservices::v1::Gateway >

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

ListGateways(google::cloud::networkservices::v1::ListGatewaysRequest, Options)

Lists Gateways in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::ListGatewaysRequest

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.networkservices.v1.ListGatewaysRequest. 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::networkservices::v1::Gateway >

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

GetGateway(std::string const &, Options)

Gets details of a single Gateway.

Parameters
Name Description
name std::string const &

Required. A name of the Gateway to get. Must be in the format projects/*/locations/*/gateways/*.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networkservices::v1::Gateway >

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

GetGateway(google::cloud::networkservices::v1::GetGatewayRequest const &, Options)

Gets details of a single Gateway.

Parameters
Name Description
request google::cloud::networkservices::v1::GetGatewayRequest 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.networkservices.v1.GetGatewayRequest. 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::networkservices::v1::Gateway >

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

CreateGateway(std::string const &, google::cloud::networkservices::v1::Gateway const &, std::string const &, Options)

Creates a new Gateway in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the Gateway. Must be in the format projects/*/locations/*.

gateway google::cloud::networkservices::v1::Gateway const &

Required. Gateway resource to be created.

gateway_id std::string const &

Required. Short name of the Gateway resource to be created.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::Gateway > >

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

CreateGateway(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::Gateway const &, std::string const &, Options)

Creates a new Gateway in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
gateway google::cloud::networkservices::v1::Gateway const &
gateway_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateGateway(google::cloud::networkservices::v1::CreateGatewayRequest const &, Options)

Creates a new Gateway in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::CreateGatewayRequest 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.networkservices.v1.CreateGatewayRequest. 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::networkservices::v1::Gateway > >

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

CreateGateway(NoAwaitTag, google::cloud::networkservices::v1::CreateGatewayRequest const &, Options)

Creates a new Gateway in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::CreateGatewayRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateGateway(google::longrunning::Operation const &, Options)

Creates a new Gateway in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::Gateway > >

UpdateGateway(google::cloud::networkservices::v1::Gateway const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Gateway.

Parameters
Name Description
gateway google::cloud::networkservices::v1::Gateway const &

Required. Updated Gateway resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the Gateway 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.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::Gateway > >

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

UpdateGateway(NoAwaitTag, google::cloud::networkservices::v1::Gateway const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Gateway.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
gateway google::cloud::networkservices::v1::Gateway const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateGateway(google::cloud::networkservices::v1::UpdateGatewayRequest const &, Options)

Updates the parameters of a single Gateway.

Parameters
Name Description
request google::cloud::networkservices::v1::UpdateGatewayRequest 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.networkservices.v1.UpdateGatewayRequest. 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::networkservices::v1::Gateway > >

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

UpdateGateway(NoAwaitTag, google::cloud::networkservices::v1::UpdateGatewayRequest const &, Options)

Updates the parameters of a single Gateway.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::UpdateGatewayRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateGateway(google::longrunning::Operation const &, Options)

Updates the parameters of a single Gateway.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::Gateway > >

DeleteGateway(std::string const &, Options)

Deletes a single Gateway.

Parameters
Name Description
name std::string const &

Required. A name of the Gateway to delete. Must be in the format projects/*/locations/*/gateways/*.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

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

DeleteGateway(NoAwaitTag, std::string const &, Options)

Deletes a single Gateway.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteGateway(google::cloud::networkservices::v1::DeleteGatewayRequest const &, Options)

Deletes a single Gateway.

Parameters
Name Description
request google::cloud::networkservices::v1::DeleteGatewayRequest 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.networkservices.v1.DeleteGatewayRequest. 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::networkservices::v1::OperationMetadata > >

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

DeleteGateway(NoAwaitTag, google::cloud::networkservices::v1::DeleteGatewayRequest const &, Options)

Deletes a single Gateway.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::DeleteGatewayRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteGateway(google::longrunning::Operation const &, Options)

Deletes a single Gateway.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

ListGrpcRoutes(std::string const &, Options)

Lists GrpcRoutes in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the GrpcRoutes should be listed, specified in the format projects/*/locations/global.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networkservices::v1::GrpcRoute >

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

ListGrpcRoutes(google::cloud::networkservices::v1::ListGrpcRoutesRequest, Options)

Lists GrpcRoutes in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::ListGrpcRoutesRequest

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.networkservices.v1.ListGrpcRoutesRequest. 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::networkservices::v1::GrpcRoute >

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

GetGrpcRoute(std::string const &, Options)

Gets details of a single GrpcRoute.

Parameters
Name Description
name std::string const &

Required. A name of the GrpcRoute to get. Must be in the format projects/*/locations/global/grpcRoutes/*.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networkservices::v1::GrpcRoute >

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

GetGrpcRoute(google::cloud::networkservices::v1::GetGrpcRouteRequest const &, Options)

Gets details of a single GrpcRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::GetGrpcRouteRequest 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.networkservices.v1.GetGrpcRouteRequest. 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::networkservices::v1::GrpcRoute >

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

CreateGrpcRoute(std::string const &, google::cloud::networkservices::v1::GrpcRoute const &, std::string const &, Options)

Creates a new GrpcRoute in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the GrpcRoute. Must be in the format projects/*/locations/global.

grpc_route google::cloud::networkservices::v1::GrpcRoute const &

Required. GrpcRoute resource to be created.

grpc_route_id std::string const &

Required. Short name of the GrpcRoute resource to be created.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::GrpcRoute > >

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

CreateGrpcRoute(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::GrpcRoute const &, std::string const &, Options)

Creates a new GrpcRoute in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
grpc_route google::cloud::networkservices::v1::GrpcRoute const &
grpc_route_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateGrpcRoute(google::cloud::networkservices::v1::CreateGrpcRouteRequest const &, Options)

Creates a new GrpcRoute in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::CreateGrpcRouteRequest 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.networkservices.v1.CreateGrpcRouteRequest. 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::networkservices::v1::GrpcRoute > >

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

CreateGrpcRoute(NoAwaitTag, google::cloud::networkservices::v1::CreateGrpcRouteRequest const &, Options)

Creates a new GrpcRoute in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::CreateGrpcRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateGrpcRoute(google::longrunning::Operation const &, Options)

Creates a new GrpcRoute in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::GrpcRoute > >

UpdateGrpcRoute(google::cloud::networkservices::v1::GrpcRoute const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single GrpcRoute.

Parameters
Name Description
grpc_route google::cloud::networkservices::v1::GrpcRoute const &

Required. Updated GrpcRoute resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute 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.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::GrpcRoute > >

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

UpdateGrpcRoute(NoAwaitTag, google::cloud::networkservices::v1::GrpcRoute const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single GrpcRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
grpc_route google::cloud::networkservices::v1::GrpcRoute const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateGrpcRoute(google::cloud::networkservices::v1::UpdateGrpcRouteRequest const &, Options)

Updates the parameters of a single GrpcRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::UpdateGrpcRouteRequest 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.networkservices.v1.UpdateGrpcRouteRequest. 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::networkservices::v1::GrpcRoute > >

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

UpdateGrpcRoute(NoAwaitTag, google::cloud::networkservices::v1::UpdateGrpcRouteRequest const &, Options)

Updates the parameters of a single GrpcRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::UpdateGrpcRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateGrpcRoute(google::longrunning::Operation const &, Options)

Updates the parameters of a single GrpcRoute.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::GrpcRoute > >

DeleteGrpcRoute(std::string const &, Options)

Deletes a single GrpcRoute.

Parameters
Name Description
name std::string const &

Required. A name of the GrpcRoute to delete. Must be in the format projects/*/locations/global/grpcRoutes/*.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

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

DeleteGrpcRoute(NoAwaitTag, std::string const &, Options)

Deletes a single GrpcRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteGrpcRoute(google::cloud::networkservices::v1::DeleteGrpcRouteRequest const &, Options)

Deletes a single GrpcRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::DeleteGrpcRouteRequest 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.networkservices.v1.DeleteGrpcRouteRequest. 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::networkservices::v1::OperationMetadata > >

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

DeleteGrpcRoute(NoAwaitTag, google::cloud::networkservices::v1::DeleteGrpcRouteRequest const &, Options)

Deletes a single GrpcRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::DeleteGrpcRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteGrpcRoute(google::longrunning::Operation const &, Options)

Deletes a single GrpcRoute.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

ListHttpRoutes(std::string const &, Options)

Lists HttpRoute in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the HttpRoutes should be listed, specified in the format projects/*/locations/global.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networkservices::v1::HttpRoute >

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

ListHttpRoutes(google::cloud::networkservices::v1::ListHttpRoutesRequest, Options)

Lists HttpRoute in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::ListHttpRoutesRequest

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.networkservices.v1.ListHttpRoutesRequest. 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::networkservices::v1::HttpRoute >

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

GetHttpRoute(std::string const &, Options)

Gets details of a single HttpRoute.

Parameters
Name Description
name std::string const &

Required. A name of the HttpRoute to get. Must be in the format projects/*/locations/global/httpRoutes/*.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networkservices::v1::HttpRoute >

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

GetHttpRoute(google::cloud::networkservices::v1::GetHttpRouteRequest const &, Options)

Gets details of a single HttpRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::GetHttpRouteRequest 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.networkservices.v1.GetHttpRouteRequest. 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::networkservices::v1::HttpRoute >

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

CreateHttpRoute(std::string const &, google::cloud::networkservices::v1::HttpRoute const &, std::string const &, Options)

Creates a new HttpRoute in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the HttpRoute. Must be in the format projects/*/locations/global.

http_route google::cloud::networkservices::v1::HttpRoute const &

Required. HttpRoute resource to be created.

http_route_id std::string const &

Required. Short name of the HttpRoute resource to be created.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::HttpRoute > >

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

CreateHttpRoute(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::HttpRoute const &, std::string const &, Options)

Creates a new HttpRoute in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
http_route google::cloud::networkservices::v1::HttpRoute const &
http_route_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateHttpRoute(google::cloud::networkservices::v1::CreateHttpRouteRequest const &, Options)

Creates a new HttpRoute in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::CreateHttpRouteRequest 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.networkservices.v1.CreateHttpRouteRequest. 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::networkservices::v1::HttpRoute > >

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

CreateHttpRoute(NoAwaitTag, google::cloud::networkservices::v1::CreateHttpRouteRequest const &, Options)

Creates a new HttpRoute in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::CreateHttpRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateHttpRoute(google::longrunning::Operation const &, Options)

Creates a new HttpRoute in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::HttpRoute > >

UpdateHttpRoute(google::cloud::networkservices::v1::HttpRoute const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single HttpRoute.

Parameters
Name Description
http_route google::cloud::networkservices::v1::HttpRoute const &

Required. Updated HttpRoute resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute 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.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::HttpRoute > >

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

UpdateHttpRoute(NoAwaitTag, google::cloud::networkservices::v1::HttpRoute const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single HttpRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
http_route google::cloud::networkservices::v1::HttpRoute const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateHttpRoute(google::cloud::networkservices::v1::UpdateHttpRouteRequest const &, Options)

Updates the parameters of a single HttpRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::UpdateHttpRouteRequest 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.networkservices.v1.UpdateHttpRouteRequest. 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::networkservices::v1::HttpRoute > >

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

UpdateHttpRoute(NoAwaitTag, google::cloud::networkservices::v1::UpdateHttpRouteRequest const &, Options)

Updates the parameters of a single HttpRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::UpdateHttpRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateHttpRoute(google::longrunning::Operation const &, Options)

Updates the parameters of a single HttpRoute.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::HttpRoute > >

DeleteHttpRoute(std::string const &, Options)

Deletes a single HttpRoute.

Parameters
Name Description
name std::string const &

Required. A name of the HttpRoute to delete. Must be in the format projects/*/locations/global/httpRoutes/*.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

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

DeleteHttpRoute(NoAwaitTag, std::string const &, Options)

Deletes a single HttpRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteHttpRoute(google::cloud::networkservices::v1::DeleteHttpRouteRequest const &, Options)

Deletes a single HttpRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::DeleteHttpRouteRequest 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.networkservices.v1.DeleteHttpRouteRequest. 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::networkservices::v1::OperationMetadata > >

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

DeleteHttpRoute(NoAwaitTag, google::cloud::networkservices::v1::DeleteHttpRouteRequest const &, Options)

Deletes a single HttpRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::DeleteHttpRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteHttpRoute(google::longrunning::Operation const &, Options)

Deletes a single HttpRoute.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

ListTcpRoutes(std::string const &, Options)

Lists TcpRoute in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the TcpRoutes should be listed, specified in the format projects/*/locations/global.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networkservices::v1::TcpRoute >

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

ListTcpRoutes(google::cloud::networkservices::v1::ListTcpRoutesRequest, Options)

Lists TcpRoute in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::ListTcpRoutesRequest

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.networkservices.v1.ListTcpRoutesRequest. 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::networkservices::v1::TcpRoute >

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

GetTcpRoute(std::string const &, Options)

Gets details of a single TcpRoute.

Parameters
Name Description
name std::string const &

Required. A name of the TcpRoute to get. Must be in the format projects/*/locations/global/tcpRoutes/*.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networkservices::v1::TcpRoute >

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

GetTcpRoute(google::cloud::networkservices::v1::GetTcpRouteRequest const &, Options)

Gets details of a single TcpRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::GetTcpRouteRequest 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.networkservices.v1.GetTcpRouteRequest. 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::networkservices::v1::TcpRoute >

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

CreateTcpRoute(std::string const &, google::cloud::networkservices::v1::TcpRoute const &, std::string const &, Options)

Creates a new TcpRoute in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the TcpRoute. Must be in the format projects/*/locations/global.

tcp_route google::cloud::networkservices::v1::TcpRoute const &

Required. TcpRoute resource to be created.

tcp_route_id std::string const &

Required. Short name of the TcpRoute resource to be created.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::TcpRoute > >

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

CreateTcpRoute(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::TcpRoute const &, std::string const &, Options)

Creates a new TcpRoute in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
tcp_route google::cloud::networkservices::v1::TcpRoute const &
tcp_route_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateTcpRoute(google::cloud::networkservices::v1::CreateTcpRouteRequest const &, Options)

Creates a new TcpRoute in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::CreateTcpRouteRequest 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.networkservices.v1.CreateTcpRouteRequest. 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::networkservices::v1::TcpRoute > >

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

CreateTcpRoute(NoAwaitTag, google::cloud::networkservices::v1::CreateTcpRouteRequest const &, Options)

Creates a new TcpRoute in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::CreateTcpRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateTcpRoute(google::longrunning::Operation const &, Options)

Creates a new TcpRoute in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::TcpRoute > >

UpdateTcpRoute(google::cloud::networkservices::v1::TcpRoute const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single TcpRoute.

Parameters
Name Description
tcp_route google::cloud::networkservices::v1::TcpRoute const &

Required. Updated TcpRoute resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the TcpRoute 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.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::TcpRoute > >

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

UpdateTcpRoute(NoAwaitTag, google::cloud::networkservices::v1::TcpRoute const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single TcpRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
tcp_route google::cloud::networkservices::v1::TcpRoute const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateTcpRoute(google::cloud::networkservices::v1::UpdateTcpRouteRequest const &, Options)

Updates the parameters of a single TcpRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::UpdateTcpRouteRequest 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.networkservices.v1.UpdateTcpRouteRequest. 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::networkservices::v1::TcpRoute > >

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

UpdateTcpRoute(NoAwaitTag, google::cloud::networkservices::v1::UpdateTcpRouteRequest const &, Options)

Updates the parameters of a single TcpRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::UpdateTcpRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateTcpRoute(google::longrunning::Operation const &, Options)

Updates the parameters of a single TcpRoute.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::TcpRoute > >

DeleteTcpRoute(std::string const &, Options)

Deletes a single TcpRoute.

Parameters
Name Description
name std::string const &

Required. A name of the TcpRoute to delete. Must be in the format projects/*/locations/global/tcpRoutes/*.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

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

DeleteTcpRoute(NoAwaitTag, std::string const &, Options)

Deletes a single TcpRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteTcpRoute(google::cloud::networkservices::v1::DeleteTcpRouteRequest const &, Options)

Deletes a single TcpRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::DeleteTcpRouteRequest 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.networkservices.v1.DeleteTcpRouteRequest. 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::networkservices::v1::OperationMetadata > >

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

DeleteTcpRoute(NoAwaitTag, google::cloud::networkservices::v1::DeleteTcpRouteRequest const &, Options)

Deletes a single TcpRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::DeleteTcpRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteTcpRoute(google::longrunning::Operation const &, Options)

Deletes a single TcpRoute.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

ListTlsRoutes(std::string const &, Options)

Lists TlsRoute in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the TlsRoutes should be listed, specified in the format projects/*/locations/global.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networkservices::v1::TlsRoute >

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

ListTlsRoutes(google::cloud::networkservices::v1::ListTlsRoutesRequest, Options)

Lists TlsRoute in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::ListTlsRoutesRequest

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.networkservices.v1.ListTlsRoutesRequest. 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::networkservices::v1::TlsRoute >

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

GetTlsRoute(std::string const &, Options)

Gets details of a single TlsRoute.

Parameters
Name Description
name std::string const &

Required. A name of the TlsRoute to get. Must be in the format projects/*/locations/global/tlsRoutes/*.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networkservices::v1::TlsRoute >

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

GetTlsRoute(google::cloud::networkservices::v1::GetTlsRouteRequest const &, Options)

Gets details of a single TlsRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::GetTlsRouteRequest 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.networkservices.v1.GetTlsRouteRequest. 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::networkservices::v1::TlsRoute >

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

CreateTlsRoute(std::string const &, google::cloud::networkservices::v1::TlsRoute const &, std::string const &, Options)

Creates a new TlsRoute in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the TlsRoute. Must be in the format projects/*/locations/global.

tls_route google::cloud::networkservices::v1::TlsRoute const &

Required. TlsRoute resource to be created.

tls_route_id std::string const &

Required. Short name of the TlsRoute resource to be created.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::TlsRoute > >

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

CreateTlsRoute(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::TlsRoute const &, std::string const &, Options)

Creates a new TlsRoute in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
tls_route google::cloud::networkservices::v1::TlsRoute const &
tls_route_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateTlsRoute(google::cloud::networkservices::v1::CreateTlsRouteRequest const &, Options)

Creates a new TlsRoute in a given project and location.

Parameters
Name Description
request google::cloud::networkservices::v1::CreateTlsRouteRequest 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.networkservices.v1.CreateTlsRouteRequest. 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::networkservices::v1::TlsRoute > >

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

CreateTlsRoute(NoAwaitTag, google::cloud::networkservices::v1::CreateTlsRouteRequest const &, Options)

Creates a new TlsRoute in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::CreateTlsRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateTlsRoute(google::longrunning::Operation const &, Options)

Creates a new TlsRoute in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::TlsRoute > >

UpdateTlsRoute(google::cloud::networkservices::v1::TlsRoute const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single TlsRoute.

Parameters
Name Description
tls_route google::cloud::networkservices::v1::TlsRoute const &

Required. Updated TlsRoute resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the TlsRoute 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.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::TlsRoute > >

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

UpdateTlsRoute(NoAwaitTag, google::cloud::networkservices::v1::TlsRoute const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single TlsRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
tls_route google::cloud::networkservices::v1::TlsRoute const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateTlsRoute(google::cloud::networkservices::v1::UpdateTlsRouteRequest const &, Options)

Updates the parameters of a single TlsRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::UpdateTlsRouteRequest 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.networkservices.v1.UpdateTlsRouteRequest. 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::networkservices::v1::TlsRoute > >

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

UpdateTlsRoute(NoAwaitTag, google::cloud::networkservices::v1::UpdateTlsRouteRequest const &, Options)

Updates the parameters of a single TlsRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::UpdateTlsRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateTlsRoute(google::longrunning::Operation const &, Options)

Updates the parameters of a single TlsRoute.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::TlsRoute > >

DeleteTlsRoute(std::string const &, Options)

Deletes a single TlsRoute.

Parameters
Name Description
name std::string const &

Required. A name of the TlsRoute to delete. Must be in the format projects/*/locations/global/tlsRoutes/*.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

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

DeleteTlsRoute(NoAwaitTag, std::string const &, Options)

Deletes a single TlsRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteTlsRoute(google::cloud::networkservices::v1::DeleteTlsRouteRequest const &, Options)

Deletes a single TlsRoute.

Parameters
Name Description
request google::cloud::networkservices::v1::DeleteTlsRouteRequest 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.networkservices.v1.DeleteTlsRouteRequest. 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::networkservices::v1::OperationMetadata > >

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

DeleteTlsRoute(NoAwaitTag, google::cloud::networkservices::v1::DeleteTlsRouteRequest const &, Options)

Deletes a single TlsRoute.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::networkservices::v1::DeleteTlsRouteRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteTlsRoute(google::longrunning::Operation const &, Options)

Deletes a single TlsRoute.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::networkservices::v1::OperationMetadata > >

ListServiceBindings(std::string const &, Options)

Lists ServiceBinding in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the ServiceBindings should be listed, specified in the format projects/*/locations/global.

opts Op