Class NetworkServicesClient (2.45.0-rc)

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 > >

ListWasmPluginVersions(std::string const &, Options)

Lists WasmPluginVersion resources in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The WasmPlugin resource whose WasmPluginVersions are listed, specified in the following format: projects/{project}/locations/global/wasmPlugins/{wasm_plugin}.

opts Options

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

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

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

ListWasmPluginVersions(google::cloud::networkservices::v1::ListWasmPluginVersionsRequest, Options)

Lists WasmPluginVersion resources in a given project and location.

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

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.ListWasmPluginVersionsRequest. 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::WasmPluginVersion >

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

GetWasmPluginVersion(std::string const &, Options)

Gets details of the specified WasmPluginVersion resource.

Parameters
Name Description
name std::string const &

Required. A name of the WasmPluginVersion resource to get. Must be in the format projects/{project}/locations/global/wasmPlugins/{wasm_plugin}/versions/{wasm_plugin_version}.

opts Options

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

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

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

GetWasmPluginVersion(google::cloud::networkservices::v1::GetWasmPluginVersionRequest const &, Options)

Gets details of the specified WasmPluginVersion resource.

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

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

CreateWasmPluginVersion(std::string const &, google::cloud::networkservices::v1::WasmPluginVersion const &, std::string const &, Options)

Creates a new WasmPluginVersion resource in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the WasmPluginVersion resource. Must be in the format projects/{project}/locations/global/wasmPlugins/{wasm_plugin}.

wasm_plugin_version google::cloud::networkservices::v1::WasmPluginVersion const &

Required. WasmPluginVersion resource to be created.

wasm_plugin_version_id std::string const &

Required. User-provided ID of the WasmPluginVersion 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::WasmPluginVersion > >

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

CreateWasmPluginVersion(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::WasmPluginVersion const &, std::string const &, Options)

Creates a new WasmPluginVersion resource 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 &
wasm_plugin_version google::cloud::networkservices::v1::WasmPluginVersion const &
wasm_plugin_version_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateWasmPluginVersion(google::cloud::networkservices::v1::CreateWasmPluginVersionRequest const &, Options)

Creates a new WasmPluginVersion resource in a given project and location.

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

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

CreateWasmPluginVersion(NoAwaitTag, google::cloud::networkservices::v1::CreateWasmPluginVersionRequest const &, Options)

Creates a new WasmPluginVersion resource 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::CreateWasmPluginVersionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new WasmPluginVersion resource 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::WasmPluginVersion > >

DeleteWasmPluginVersion(std::string const &, Options)

Deletes the specified WasmPluginVersion resource.

Parameters
Name Description
name std::string const &

Required. A name of the WasmPluginVersion resource to delete. Must be in the format projects/{project}/locations/global/wasmPlugins/{wasm_plugin}/versions/{wasm_plugin_version}.

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.

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

Deletes the specified WasmPluginVersion resource.

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 >

DeleteWasmPluginVersion(google::cloud::networkservices::v1::DeleteWasmPluginVersionRequest const &, Options)

Deletes the specified WasmPluginVersion resource.

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

DeleteWasmPluginVersion(NoAwaitTag, google::cloud::networkservices::v1::DeleteWasmPluginVersionRequest const &, Options)

Deletes the specified WasmPluginVersion resource.

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::DeleteWasmPluginVersionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes the specified WasmPluginVersion resource.

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 > >

ListWasmPlugins(std::string const &, Options)

Lists WasmPlugin resources in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the WasmPlugin resources are listed, specified in the following format: projects/{project}/locations/global.

opts Options

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

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

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

ListWasmPlugins(google::cloud::networkservices::v1::ListWasmPluginsRequest, Options)

Lists WasmPlugin resources in a given project and location.

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

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.ListWasmPluginsRequest. 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::WasmPlugin >

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

GetWasmPlugin(std::string const &, Options)

Gets details of the specified WasmPlugin resource.

Parameters
Name Description
name std::string const &

Required. A name of the WasmPlugin resource to get. Must be in the format projects/{project}/locations/global/wasmPlugins/{wasm_plugin}.

opts Options

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

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

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

GetWasmPlugin(google::cloud::networkservices::v1::GetWasmPluginRequest const &, Options)

Gets details of the specified WasmPlugin resource.

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

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

CreateWasmPlugin(std::string const &, google::cloud::networkservices::v1::WasmPlugin const &, std::string const &, Options)

Creates a new WasmPlugin resource in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the WasmPlugin resource. Must be in the format projects/{project}/locations/global.

wasm_plugin google::cloud::networkservices::v1::WasmPlugin const &

Required. WasmPlugin resource to be created.

wasm_plugin_id std::string const &

Required. User-provided ID of the WasmPlugin 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::WasmPlugin > >

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

CreateWasmPlugin(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::WasmPlugin const &, std::string const &, Options)

Creates a new WasmPlugin resource 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 &
wasm_plugin google::cloud::networkservices::v1::WasmPlugin const &
wasm_plugin_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateWasmPlugin(google::cloud::networkservices::v1::CreateWasmPluginRequest const &, Options)

Creates a new WasmPlugin resource in a given project and location.

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

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

CreateWasmPlugin(NoAwaitTag, google::cloud::networkservices::v1::CreateWasmPluginRequest const &, Options)

Creates a new WasmPlugin resource 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::CreateWasmPluginRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new WasmPlugin resource 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::WasmPlugin > >

UpdateWasmPlugin(google::cloud::networkservices::v1::WasmPlugin const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of the specified WasmPlugin resource.

Parameters
Name Description
wasm_plugin google::cloud::networkservices::v1::WasmPlugin const &

Required. Updated WasmPlugin resource.

update_mask google::protobuf::FieldMask const &

Optional. Used to specify the fields to be overwritten in the WasmPlugin resource by the update. The fields specified in the update_mask field are relative to the resource, not the full request. An omitted update_mask field is treated as an implied update_mask field equivalent to all fields that are populated (that have a non-empty value). The update_mask field supports a special value *, which means that each field in the given WasmPlugin resource (including the empty ones) replaces the current value.

opts Options

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

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

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

UpdateWasmPlugin(NoAwaitTag, google::cloud::networkservices::v1::WasmPlugin const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of the specified WasmPlugin resource.

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
wasm_plugin google::cloud::networkservices::v1::WasmPlugin const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateWasmPlugin(google::cloud::networkservices::v1::UpdateWasmPluginRequest const &, Options)

Updates the parameters of the specified WasmPlugin resource.

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

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

UpdateWasmPlugin(NoAwaitTag, google::cloud::networkservices::v1::UpdateWasmPluginRequest const &, Options)

Updates the parameters of the specified WasmPlugin resource.

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::UpdateWasmPluginRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates the parameters of the specified WasmPlugin resource.

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::WasmPlugin > >

DeleteWasmPlugin(std::string const &, Options)

Deletes the specified WasmPlugin resource.

Parameters
Name Description
name std::string const &

Required. A name of the WasmPlugin resource to delete. Must be in the format projects/{project}/locations/global/wasmPlugins/{wasm_plugin}.

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.

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

Deletes the specified WasmPlugin resource.

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 >

DeleteWasmPlugin(google::cloud::networkservices::v1::DeleteWasmPluginRequest const &, Options)

Deletes the specified WasmPlugin resource.

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

DeleteWasmPlugin(NoAwaitTag, google::cloud::networkservices::v1::DeleteWasmPluginRequest const &, Options)

Deletes the specified WasmPlugin resource.

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::DeleteWasmPluginRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes the specified WasmPlugin resource.

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/*.

opts Options

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

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

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

ListServiceBindings(google::cloud::networkservices::v1::ListServiceBindingsRequest, Options)

Lists ServiceBinding in a given project and location.

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

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.ListServiceBindingsRequest. 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::ServiceBinding >

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

GetServiceBinding(std::string const &, Options)

Gets details of a single ServiceBinding.

Parameters
Name Description
name std::string const &

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

opts Options

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

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

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

GetServiceBinding(google::cloud::networkservices::v1::GetServiceBindingRequest const &, Options)

Gets details of a single ServiceBinding.

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

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

CreateServiceBinding(std::string const &, google::cloud::networkservices::v1::ServiceBinding const &, std::string const &, Options)

Creates a new ServiceBinding in a given project and location.

Parameters
Name Description
parent std::string const &

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

service_binding google::cloud::networkservices::v1::ServiceBinding const &

Required. ServiceBinding resource to be created.

service_binding_id std::string const &

Required. Short name of the ServiceBinding 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::ServiceBinding > >

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

CreateServiceBinding(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::ServiceBinding const &, std::string const &, Options)

Creates a new ServiceBinding 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 &
service_binding google::cloud::networkservices::v1::ServiceBinding const &
service_binding_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateServiceBinding(google::cloud::networkservices::v1::CreateServiceBindingRequest const &, Options)

Creates a new ServiceBinding in a given project and location.

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

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

CreateServiceBinding(NoAwaitTag, google::cloud::networkservices::v1::CreateServiceBindingRequest const &, Options)

Creates a new ServiceBinding 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::CreateServiceBindingRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new ServiceBinding 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::ServiceBinding > >

UpdateServiceBinding(google::cloud::networkservices::v1::ServiceBinding const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ServiceBinding.

Parameters
Name Description
service_binding google::cloud::networkservices::v1::ServiceBinding const &

Required. Updated ServiceBinding resource.

update_mask google::protobuf::FieldMask const &

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

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

UpdateServiceBinding(NoAwaitTag, google::cloud::networkservices::v1::ServiceBinding const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ServiceBinding.

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
service_binding google::cloud::networkservices::v1::ServiceBinding const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateServiceBinding(google::cloud::networkservices::v1::UpdateServiceBindingRequest const &, Options)

Updates the parameters of a single ServiceBinding.

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

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

UpdateServiceBinding(NoAwaitTag, google::cloud::networkservices::v1::UpdateServiceBindingRequest const &, Options)

Updates the parameters of a single ServiceBinding.

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::UpdateServiceBindingRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates the parameters of a single ServiceBinding.

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::ServiceBinding > >

DeleteServiceBinding(std::string const &, Options)

Deletes a single ServiceBinding.

Parameters
Name Description
name std::string const &

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

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.

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

Deletes a single ServiceBinding.

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 >

DeleteServiceBinding(google::cloud::networkservices::v1::DeleteServiceBindingRequest const &, Options)

Deletes a single ServiceBinding.

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

DeleteServiceBinding(NoAwaitTag, google::cloud::networkservices::v1::DeleteServiceBindingRequest const &, Options)

Deletes a single ServiceBinding.

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::DeleteServiceBindingRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes a single ServiceBinding.

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 > >

ListMeshes(std::string const &, Options)

Lists Meshes in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the Meshes 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::Mesh >

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

ListMeshes(google::cloud::networkservices::v1::ListMeshesRequest, Options)

Lists Meshes in a given project and location.

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

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.ListMeshesRequest. 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::Mesh >

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

GetMesh(std::string const &, Options)

Gets details of a single Mesh.

Parameters
Name Description
name std::string const &

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

opts Options

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

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

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

GetMesh(google::cloud::networkservices::v1::GetMeshRequest const &, Options)

Gets details of a single Mesh.

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

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

CreateMesh(std::string const &, google::cloud::networkservices::v1::Mesh const &, std::string const &, Options)

Creates a new Mesh in a given project and location.

Parameters
Name Description
parent std::string const &

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

mesh google::cloud::networkservices::v1::Mesh const &

Required. Mesh resource to be created.

mesh_id std::string const &

Required. Short name of the Mesh 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::Mesh > >

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

CreateMesh(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::Mesh const &, std::string const &, Options)

Creates a new Mesh 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 &
mesh google::cloud::networkservices::v1::Mesh const &
mesh_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateMesh(google::cloud::networkservices::v1::CreateMeshRequest const &, Options)

Creates a new Mesh in a given project and location.

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

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

CreateMesh(NoAwaitTag, google::cloud::networkservices::v1::CreateMeshRequest const &, Options)

Creates a new Mesh 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::CreateMeshRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new Mesh 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::Mesh > >

UpdateMesh(google::cloud::networkservices::v1::Mesh const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Mesh.

Parameters
Name Description
mesh google::cloud::networkservices::v1::Mesh const &

Required. Updated Mesh resource.

update_mask google::protobuf::FieldMask const &

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

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

UpdateMesh(NoAwaitTag, google::cloud::networkservices::v1::Mesh const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Mesh.

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
mesh google::cloud::networkservices::v1::Mesh const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateMesh(google::cloud::networkservices::v1::UpdateMeshRequest const &, Options)

Updates the parameters of a single Mesh.

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

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

UpdateMesh(NoAwaitTag, google::cloud::networkservices::v1::UpdateMeshRequest const &, Options)

Updates the parameters of a single Mesh.

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::UpdateMeshRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates the parameters of a single Mesh.

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::Mesh > >

DeleteMesh(std::string const &, Options)

Deletes a single Mesh.

Parameters
Name Description
name std::string const &

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

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.

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

Deletes a single Mesh.

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 >

DeleteMesh(google::cloud::networkservices::v1::DeleteMeshRequest const &, Options)

Deletes a single Mesh.

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

DeleteMesh(NoAwaitTag, google::cloud::networkservices::v1::DeleteMeshRequest const &, Options)

Deletes a single Mesh.

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::DeleteMeshRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes a single Mesh.

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 > >

ListServiceLbPolicies(std::string const &, Options)

Lists ServiceLbPolicies in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the ServiceLbPolicies should be listed, specified in the format projects/{project}/locations/{location}.

opts Options

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

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

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

ListServiceLbPolicies(google::cloud::networkservices::v1::ListServiceLbPoliciesRequest, Options)

Lists ServiceLbPolicies in a given project and location.

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

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.ListServiceLbPoliciesRequest. 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::ServiceLbPolicy >

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

GetServiceLbPolicy(std::string const &, Options)

Gets details of a single ServiceLbPolicy.

Parameters
Name Description
name std::string const &

Required. A name of the ServiceLbPolicy to get. Must be in the format projects/{project}/locations/{location}/serviceLbPolicies/*.

opts Options

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

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

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

GetServiceLbPolicy(google::cloud::networkservices::v1::GetServiceLbPolicyRequest const &, Options)

Gets details of a single ServiceLbPolicy.

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

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

CreateServiceLbPolicy(std::string const &, google::cloud::networkservices::v1::ServiceLbPolicy const &, std::string const &, Options)

Creates a new ServiceLbPolicy in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the ServiceLbPolicy. Must be in the format projects/{project}/locations/{location}.

service_lb_policy google::cloud::networkservices::v1::ServiceLbPolicy const &

Required. ServiceLbPolicy resource to be created.

service_lb_policy_id std::string const &

Required. Short name of the ServiceLbPolicy resource to be created. E.g. for resource name projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}. the id is value of {service_lb_policy_name}

opts Options

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

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

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

CreateServiceLbPolicy(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::ServiceLbPolicy const &, std::string const &, Options)

Creates a new ServiceLbPolicy 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 &
service_lb_policy google::cloud::networkservices::v1::ServiceLbPolicy const &
service_lb_policy_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateServiceLbPolicy(google::cloud::networkservices::v1::CreateServiceLbPolicyRequest const &, Options)

Creates a new ServiceLbPolicy in a given project and location.

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

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

CreateServiceLbPolicy(NoAwaitTag, google::cloud::networkservices::v1::CreateServiceLbPolicyRequest const &, Options)

Creates a new ServiceLbPolicy 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::CreateServiceLbPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new ServiceLbPolicy 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::ServiceLbPolicy > >

UpdateServiceLbPolicy(google::cloud::networkservices::v1::ServiceLbPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ServiceLbPolicy.

Parameters
Name Description
service_lb_policy google::cloud::networkservices::v1::ServiceLbPolicy const &

Required. Updated ServiceLbPolicy resource.

update_mask google::protobuf::FieldMask const &

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

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

UpdateServiceLbPolicy(NoAwaitTag, google::cloud::networkservices::v1::ServiceLbPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ServiceLbPolicy.

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
service_lb_policy google::cloud::networkservices::v1::ServiceLbPolicy const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateServiceLbPolicy(google::cloud::networkservices::v1::UpdateServiceLbPolicyRequest const &, Options)

Updates the parameters of a single ServiceLbPolicy.

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

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

UpdateServiceLbPolicy(NoAwaitTag, google::cloud::networkservices::v1::UpdateServiceLbPolicyRequest const &, Options)

Updates the parameters of a single ServiceLbPolicy.

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::UpdateServiceLbPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates the parameters of a single ServiceLbPolicy.

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::ServiceLbPolicy > >

DeleteServiceLbPolicy(std::string const &, Options)

Deletes a single ServiceLbPolicy.

Parameters
Name Description
name std::string const &

Required. A name of the ServiceLbPolicy to delete. Must be in the format projects/{project}/locations/{location}/serviceLbPolicies/*.

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.

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

Deletes a single ServiceLbPolicy.

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 >

DeleteServiceLbPolicy(google::cloud::networkservices::v1::DeleteServiceLbPolicyRequest const &, Options)

Deletes a single ServiceLbPolicy.

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

DeleteServiceLbPolicy(NoAwaitTag, google::cloud::networkservices::v1::DeleteServiceLbPolicyRequest const &, Options)

Deletes a single ServiceLbPolicy.

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::DeleteServiceLbPolicyRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes a single ServiceLbPolicy.

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 > >

GetGatewayRouteView(std::string const &, Options)

Get a single RouteView of a Gateway.

Parameters
Name Description
name std::string const &

Required. Name of the GatewayRouteView resource. Formats: projects/{project}/locations/{location}/gateways/{gateway}/routeViews/{route_view}

opts Options

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

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

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

GetGatewayRouteView(google::cloud::networkservices::v1::GetGatewayRouteViewRequest const &, Options)

Get a single RouteView of a Gateway.

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

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

GetMeshRouteView(std::string const &, Options)

Get a single RouteView of a Mesh.

Parameters
Name Description
name std::string const &

Required. Name of the MeshRouteView resource. Format: projects/{project}/locations/{location}/meshes/{mesh}/routeViews/{route_view}

opts Options

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

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

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

GetMeshRouteView(google::cloud::networkservices::v1::GetMeshRouteViewRequest const &, Options)

Get a single RouteView of a Mesh.

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

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

ListGatewayRouteViews(std::string const &, Options)

Lists RouteViews.

Parameters
Name Description
parent std::string const &

Required. The Gateway to which a Route is associated. Formats: projects/{project}/locations/{location}/gateways/{gateway}

opts Options

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

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

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

ListGatewayRouteViews(google::cloud::networkservices::v1::ListGatewayRouteViewsRequest, Options)

Lists RouteViews.

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

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.ListGatewayRouteViewsRequest. 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::GatewayRouteView >

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

ListMeshRouteViews(std::string const &, Options)

Lists RouteViews.

Parameters
Name Description
parent std::string const &

Required. The Mesh to which a Route is associated. Format: projects/{project}/locations/{location}/meshes/{mesh}

opts Options

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

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

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

ListMeshRouteViews(google::cloud::networkservices::v1::ListMeshRouteViewsRequest, Options)

Lists RouteViews.

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

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.ListMeshRouteViewsRequest. 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::MeshRouteView >

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

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name Description
request google::cloud::location::ListLocationsRequest

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.location.ListLocationsRequest. 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::location::Location >

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

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name Description
request google::cloud::location::GetLocationRequest 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.location.GetLocationRequest. 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::location::Location >

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

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name Description
request google::iam::v1::SetIamPolicyRequest 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.iam.v1.SetIamPolicyRequest. 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::iam::v1::Policy >

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

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a resource.

Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name Description
request google::iam::v1::GetIamPolicyRequest 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.iam.v1.GetIamPolicyRequest. 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::iam::v1::Policy >

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

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request google::iam::v1::TestIamPermissionsRequest 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.iam.v1.TestIamPermissionsRequest. 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::iam::v1::TestIamPermissionsResponse >

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

ListOperations(std::string const &, std::string const &, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation's parent resource.

filter std::string const &

The standard list filter.

opts Options

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

Returns
Type Description
StreamRange< google::longrunning::Operation >

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

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::ListOperationsRequest

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.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
name std::string const &

The name of the operation resource.

opts Options

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

Returns
Type Description
StatusOr< google::longrunning::Operation >

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

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request google::longrunning::GetOperationRequest 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.longrunning.GetOperationRequest. 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::longrunning::Operation >

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

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be deleted.

opts Options

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

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::DeleteOperationRequest 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.longrunning.DeleteOperationRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be cancelled.

opts Options

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

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request google::longrunning::CancelOperationRequest 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.longrunning.CancelOperationRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.