Class DepServiceClient (2.23.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

DepServiceClient(DepServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DepServiceClient const &`

DepServiceClient(DepServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DepServiceClient &&`

DepServiceClient(std::shared_ptr< DepServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< DepServiceConnection >`
`opts`	`Options`

Operators

operator=(DepServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DepServiceClient const &`

Returns
Type	Description
`DepServiceClient &`

operator=(DepServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DepServiceClient &&`

Returns
Type	Description
`DepServiceClient &`

Functions

ListLbTrafficExtensions(std::string const &, Options)

Lists LbTrafficExtension resources in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following 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::LbTrafficExtension >

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

ListLbTrafficExtensions(google::cloud::networkservices::v1::ListLbTrafficExtensionsRequest, Options)

Lists LbTrafficExtension resources in a given project and location.

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

GetLbTrafficExtension(std::string const &, Options)

Gets details of the specified LbTrafficExtension resource.

Parameters
Name	Description
`name`	`std::string const &` Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetLbTrafficExtension(google::cloud::networkservices::v1::GetLbTrafficExtensionRequest const &, Options)

Gets details of the specified LbTrafficExtension resource.

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

CreateLbTrafficExtension(std::string const &, google::cloud::networkservices::v1::LbTrafficExtension const &, std::string const &, Options)

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

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project}/locations/{location}`.
`lb_traffic_extension`	`google::cloud::networkservices::v1::LbTrafficExtension const &` Required. `LbTrafficExtension` resource to be created.
`lb_traffic_extension_id`	`std::string const &` Required. User-provided ID of the `LbTrafficExtension` 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::LbTrafficExtension > >

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

CreateLbTrafficExtension(google::cloud::networkservices::v1::CreateLbTrafficExtensionRequest const &, Options)

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

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

UpdateLbTrafficExtension(google::cloud::networkservices::v1::LbTrafficExtension const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of the specified LbTrafficExtension resource.

Parameters
Name	Description
`lb_traffic_extension`	`google::cloud::networkservices::v1::LbTrafficExtension const &` Required. `LbTrafficExtension` resource being updated.
`update_mask`	`google::protobuf::FieldMask const &` Required. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::networkservices::v1::LbTrafficExtension > >

UpdateLbTrafficExtension(google::cloud::networkservices::v1::UpdateLbTrafficExtensionRequest const &, Options)

Updates the parameters of the specified LbTrafficExtension resource.

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

DeleteLbTrafficExtension(std::string const &, Options)

Deletes the specified LbTrafficExtension resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.
`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.

DeleteLbTrafficExtension(google::cloud::networkservices::v1::DeleteLbTrafficExtensionRequest const &, Options)

Deletes the specified LbTrafficExtension resource.

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

ListLbRouteExtensions(std::string const &, Options)

Lists LbRouteExtension resources in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following 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::LbRouteExtension >

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

ListLbRouteExtensions(google::cloud::networkservices::v1::ListLbRouteExtensionsRequest, Options)

Lists LbRouteExtension resources in a given project and location.

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

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

GetLbRouteExtension(std::string const &, Options)

Gets details of the specified LbRouteExtension resource.

Parameters
Name	Description
`name`	`std::string const &` Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetLbRouteExtension(google::cloud::networkservices::v1::GetLbRouteExtensionRequest const &, Options)

Gets details of the specified LbRouteExtension resource.

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

CreateLbRouteExtension(std::string const &, google::cloud::networkservices::v1::LbRouteExtension const &, std::string const &, Options)

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

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project}/locations/{location}`.
`lb_route_extension`	`google::cloud::networkservices::v1::LbRouteExtension const &` Required. `LbRouteExtension` resource to be created.
`lb_route_extension_id`	`std::string const &` Required. User-provided ID of the `LbRouteExtension` 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::LbRouteExtension > >

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

CreateLbRouteExtension(google::cloud::networkservices::v1::CreateLbRouteExtensionRequest const &, Options)

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

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

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

UpdateLbRouteExtension(google::cloud::networkservices::v1::LbRouteExtension const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of the specified LbRouteExtension resource.

Parameters
Name	Description
`lb_route_extension`	`google::cloud::networkservices::v1::LbRouteExtension const &` Required. `LbRouteExtension` resource being updated.
`update_mask`	`google::protobuf::FieldMask const &` Required. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::networkservices::v1::LbRouteExtension > >

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

UpdateLbRouteExtension(google::cloud::networkservices::v1::UpdateLbRouteExtensionRequest const &, Options)

Updates the parameters of the specified LbRouteExtension resource.

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

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

DeleteLbRouteExtension(std::string const &, Options)

Deletes the specified LbRouteExtension resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.
`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.

DeleteLbRouteExtension(google::cloud::networkservices::v1::DeleteLbRouteExtensionRequest const &, Options)

Deletes the specified LbRouteExtension resource.

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