Class DepServiceClient (2.44.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. These values are 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 >

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.

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(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::LbTrafficExtension const &, std::string const &, Options)

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

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

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(NoAwaitTag, google::cloud::networkservices::v1::CreateLbTrafficExtensionRequest const &, Options)

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

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

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

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

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.

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

Updates the parameters of the specified LbTrafficExtension 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
lb_traffic_extension google::cloud::networkservices::v1::LbTrafficExtension const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

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.

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

Updates the parameters of the specified LbTrafficExtension 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::UpdateLbTrafficExtensionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates the parameters of the specified LbTrafficExtension 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::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(NoAwaitTag, std::string const &, Options)

Deletes the specified LbTrafficExtension 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 >

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.

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

Deletes the specified LbTrafficExtension 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::DeleteLbTrafficExtensionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes the specified LbTrafficExtension 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 > >

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. These values are 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(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::LbRouteExtension const &, std::string const &, Options)

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

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.

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

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

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

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

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 &

Optional. 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(NoAwaitTag, google::cloud::networkservices::v1::LbRouteExtension const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of the specified LbRouteExtension 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
lb_route_extension google::cloud::networkservices::v1::LbRouteExtension const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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.

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

Updates the parameters of the specified LbRouteExtension 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::UpdateLbRouteExtensionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates the parameters of the specified LbRouteExtension 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::LbRouteExtension > >

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(NoAwaitTag, std::string const &, Options)

Deletes the specified LbRouteExtension 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 >

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.

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

Deletes the specified LbRouteExtension 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::DeleteLbRouteExtensionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes the specified LbRouteExtension 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 > >

ListLbEdgeExtensions(std::string const &, Options)

Lists LbEdgeExtension resources in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the LbEdgeExtension resources are listed. These values are 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::LbEdgeExtension >

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

ListLbEdgeExtensions(google::cloud::networkservices::v1::ListLbEdgeExtensionsRequest, Options)

Lists LbEdgeExtension resources in a given project and location.

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

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.ListLbEdgeExtensionsRequest. 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::LbEdgeExtension >

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

GetLbEdgeExtension(std::string const &, Options)

Gets details of the specified LbEdgeExtension resource.

Parameters
Name Description
name std::string const &

Required. A name of the LbEdgeExtension resource to get. Must be in the format projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}.

opts Options

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

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

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

GetLbEdgeExtension(google::cloud::networkservices::v1::GetLbEdgeExtensionRequest const &, Options)

Gets details of the specified LbEdgeExtension resource.

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

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

CreateLbEdgeExtension(std::string const &, google::cloud::networkservices::v1::LbEdgeExtension const &, std::string const &, Options)

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

Parameters
Name Description
parent std::string const &

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

lb_edge_extension google::cloud::networkservices::v1::LbEdgeExtension const &

Required. LbEdgeExtension resource to be created.

lb_edge_extension_id std::string const &

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

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

CreateLbEdgeExtension(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::LbEdgeExtension const &, std::string const &, Options)

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

CreateLbEdgeExtension(google::cloud::networkservices::v1::CreateLbEdgeExtensionRequest const &, Options)

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

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

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

CreateLbEdgeExtension(NoAwaitTag, google::cloud::networkservices::v1::CreateLbEdgeExtensionRequest const &, Options)

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

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

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

UpdateLbEdgeExtension(google::cloud::networkservices::v1::LbEdgeExtension const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of the specified LbEdgeExtension resource.

Parameters
Name Description
lb_edge_extension google::cloud::networkservices::v1::LbEdgeExtension const &

Required. LbEdgeExtension resource being updated.

update_mask google::protobuf::FieldMask const &

Optional. Used to specify the fields to be overwritten in the LbEdgeExtension 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::LbEdgeExtension > >

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

UpdateLbEdgeExtension(NoAwaitTag, google::cloud::networkservices::v1::LbEdgeExtension const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of the specified LbEdgeExtension 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
lb_edge_extension google::cloud::networkservices::v1::LbEdgeExtension const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateLbEdgeExtension(google::cloud::networkservices::v1::UpdateLbEdgeExtensionRequest const &, Options)

Updates the parameters of the specified LbEdgeExtension resource.

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

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

UpdateLbEdgeExtension(NoAwaitTag, google::cloud::networkservices::v1::UpdateLbEdgeExtensionRequest const &, Options)

Updates the parameters of the specified LbEdgeExtension 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::UpdateLbEdgeExtensionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates the parameters of the specified LbEdgeExtension 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::LbEdgeExtension > >

DeleteLbEdgeExtension(std::string const &, Options)

Deletes the specified LbEdgeExtension resource.

Parameters
Name Description
name std::string const &

Required. The name of the LbEdgeExtension resource to delete. Must be in the format projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_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.

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

Deletes the specified LbEdgeExtension 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 >

DeleteLbEdgeExtension(google::cloud::networkservices::v1::DeleteLbEdgeExtensionRequest const &, Options)

Deletes the specified LbEdgeExtension resource.

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

DeleteLbEdgeExtension(NoAwaitTag, google::cloud::networkservices::v1::DeleteLbEdgeExtensionRequest const &, Options)

Deletes the specified LbEdgeExtension 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::DeleteLbEdgeExtensionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes the specified LbEdgeExtension 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 > >

ListAuthzExtensions(std::string const &, Options)

Lists AuthzExtension resources in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the AuthzExtension resources are listed. These values are 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::AuthzExtension >

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

ListAuthzExtensions(google::cloud::networkservices::v1::ListAuthzExtensionsRequest, Options)

Lists AuthzExtension resources in a given project and location.

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

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.ListAuthzExtensionsRequest. 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::AuthzExtension >

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

GetAuthzExtension(std::string const &, Options)

Gets details of the specified AuthzExtension resource.

Parameters
Name Description
name std::string const &

Required. A name of the AuthzExtension resource to get. Must be in the format projects/{project}/locations/{location}/authzExtensions/{authz_extension}.

opts Options

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

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

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

GetAuthzExtension(google::cloud::networkservices::v1::GetAuthzExtensionRequest const &, Options)

Gets details of the specified AuthzExtension resource.

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

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

CreateAuthzExtension(std::string const &, google::cloud::networkservices::v1::AuthzExtension const &, std::string const &, Options)

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

Parameters
Name Description
parent std::string const &

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

authz_extension google::cloud::networkservices::v1::AuthzExtension const &

Required. AuthzExtension resource to be created.

authz_extension_id std::string const &

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

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

CreateAuthzExtension(NoAwaitTag, std::string const &, google::cloud::networkservices::v1::AuthzExtension const &, std::string const &, Options)

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

CreateAuthzExtension(google::cloud::networkservices::v1::CreateAuthzExtensionRequest const &, Options)

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

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

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

CreateAuthzExtension(NoAwaitTag, google::cloud::networkservices::v1::CreateAuthzExtensionRequest const &, Options)

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

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

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

UpdateAuthzExtension(google::cloud::networkservices::v1::AuthzExtension const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of the specified AuthzExtension resource.

Parameters
Name Description
authz_extension google::cloud::networkservices::v1::AuthzExtension const &

Required. AuthzExtension resource being updated.

update_mask google::protobuf::FieldMask const &

Required. Used to specify the fields to be overwritten in the AuthzExtension 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::AuthzExtension > >

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

UpdateAuthzExtension(NoAwaitTag, google::cloud::networkservices::v1::AuthzExtension const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of the specified AuthzExtension 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
authz_extension google::cloud::networkservices::v1::AuthzExtension const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateAuthzExtension(google::cloud::networkservices::v1::UpdateAuthzExtensionRequest const &, Options)

Updates the parameters of the specified AuthzExtension resource.

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

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

UpdateAuthzExtension(NoAwaitTag, google::cloud::networkservices::v1::UpdateAuthzExtensionRequest const &, Options)

Updates the parameters of the specified AuthzExtension 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::UpdateAuthzExtensionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates the parameters of the specified AuthzExtension 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::AuthzExtension > >

DeleteAuthzExtension(std::string const &, Options)

Deletes the specified AuthzExtension resource.

Parameters
Name Description
name std::string const &

Required. The name of the AuthzExtension resource to delete. Must be in the format projects/{project}/locations/{location}/authzExtensions/{authz_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.

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

Deletes the specified AuthzExtension 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 >

DeleteAuthzExtension(google::cloud::networkservices::v1::DeleteAuthzExtensionRequest const &, Options)

Deletes the specified AuthzExtension resource.

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

DeleteAuthzExtension(NoAwaitTag, google::cloud::networkservices::v1::DeleteAuthzExtensionRequest const &, Options)

Deletes the specified AuthzExtension 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::DeleteAuthzExtensionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes the specified AuthzExtension 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 > >

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.