Class InterceptClient (3.7.0-rc)

Service for Third-Party Packet Intercept (TPPI).

TPPI is the "in-band" flavor of the Network Security Integrations product.

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

InterceptClient(InterceptClient const &)

Copy and move support

Parameter
Name Description
InterceptClient const &

InterceptClient(InterceptClient &&)

Copy and move support

Parameter
Name Description
InterceptClient &&

InterceptClient(std::shared_ptr< InterceptConnection >, Options)

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

Operators

operator=(InterceptClient const &)

Copy and move support

Parameter
Name Description
InterceptClient const &
Returns
Type Description
InterceptClient &

operator=(InterceptClient &&)

Copy and move support

Parameter
Name Description
InterceptClient &&
Returns
Type Description
InterceptClient &

Functions

ListInterceptEndpointGroups(std::string const &, Options)

Lists endpoint groups in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent, which owns this collection of endpoint groups. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networksecurity::v1::InterceptEndpointGroup >

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

ListInterceptEndpointGroups(google::cloud::networksecurity::v1::ListInterceptEndpointGroupsRequest, Options)

Lists endpoint groups in a given project and location.

Parameters
Name Description
request google::cloud::networksecurity::v1::ListInterceptEndpointGroupsRequest

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.networksecurity.v1.ListInterceptEndpointGroupsRequest. 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::networksecurity::v1::InterceptEndpointGroup >

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

GetInterceptEndpointGroup(std::string const &, Options)

Gets a specific endpoint group.

Parameters
Name Description
name std::string const &

Required. The name of the endpoint group to retrieve. Format: projects/{project}/locations/{location}/interceptEndpointGroups/{intercept_endpoint_group}

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networksecurity::v1::InterceptEndpointGroup >

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

GetInterceptEndpointGroup(google::cloud::networksecurity::v1::GetInterceptEndpointGroupRequest const &, Options)

Gets a specific endpoint group.

Parameters
Name Description
request google::cloud::networksecurity::v1::GetInterceptEndpointGroupRequest 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.networksecurity.v1.GetInterceptEndpointGroupRequest. 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::networksecurity::v1::InterceptEndpointGroup >

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

CreateInterceptEndpointGroup(std::string const &, google::cloud::networksecurity::v1::InterceptEndpointGroup const &, std::string const &, Options)

Creates an endpoint group in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource where this endpoint group will be created. Format: projects/{project}/locations/{location}

intercept_endpoint_group google::cloud::networksecurity::v1::InterceptEndpointGroup const &

Required. The endpoint group to create.

intercept_endpoint_group_id std::string const &

Required. The ID to use for the endpoint group, which will become the final component of the endpoint group's resource name.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::v1::InterceptEndpointGroup > >

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

CreateInterceptEndpointGroup(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::InterceptEndpointGroup const &, std::string const &, Options)

Creates an endpoint group 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 &
intercept_endpoint_group google::cloud::networksecurity::v1::InterceptEndpointGroup const &
intercept_endpoint_group_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateInterceptEndpointGroup(google::cloud::networksecurity::v1::CreateInterceptEndpointGroupRequest const &, Options)

Creates an endpoint group in a given project and location.

Parameters
Name Description
request google::cloud::networksecurity::v1::CreateInterceptEndpointGroupRequest 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.networksecurity.v1.CreateInterceptEndpointGroupRequest. 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::networksecurity::v1::InterceptEndpointGroup > >

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

CreateInterceptEndpointGroup(NoAwaitTag, google::cloud::networksecurity::v1::CreateInterceptEndpointGroupRequest const &, Options)

Creates an endpoint group 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::networksecurity::v1::CreateInterceptEndpointGroupRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates an endpoint group 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::networksecurity::v1::InterceptEndpointGroup > >

UpdateInterceptEndpointGroup(google::cloud::networksecurity::v1::InterceptEndpointGroup const &, google::protobuf::FieldMask const &, Options)

Updates an endpoint group.

Parameters
Name Description
intercept_endpoint_group google::cloud::networksecurity::v1::InterceptEndpointGroup const &

Required. The endpoint group to update.

update_mask google::protobuf::FieldMask const &

Optional. The list of fields to update. Fields are specified relative to the endpoint group (e.g. description; notintercept_endpoint_group.description). See https://google.aip.dev/161 for more details.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::v1::InterceptEndpointGroup > >

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

UpdateInterceptEndpointGroup(NoAwaitTag, google::cloud::networksecurity::v1::InterceptEndpointGroup const &, google::protobuf::FieldMask const &, Options)

Updates an endpoint group.

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

UpdateInterceptEndpointGroup(google::cloud::networksecurity::v1::UpdateInterceptEndpointGroupRequest const &, Options)

Updates an endpoint group.

Parameters
Name Description
request google::cloud::networksecurity::v1::UpdateInterceptEndpointGroupRequest 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.networksecurity.v1.UpdateInterceptEndpointGroupRequest. 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::networksecurity::v1::InterceptEndpointGroup > >

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

UpdateInterceptEndpointGroup(NoAwaitTag, google::cloud::networksecurity::v1::UpdateInterceptEndpointGroupRequest const &, Options)

Updates an endpoint group.

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

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

Updates an endpoint group.

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::networksecurity::v1::InterceptEndpointGroup > >

DeleteInterceptEndpointGroup(std::string const &, Options)

Deletes an endpoint group.

Parameters
Name Description
name std::string const &

Required. The endpoint group to delete.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::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.networksecurity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes an endpoint group.

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 >

DeleteInterceptEndpointGroup(google::cloud::networksecurity::v1::DeleteInterceptEndpointGroupRequest const &, Options)

Deletes an endpoint group.

Parameters
Name Description
request google::cloud::networksecurity::v1::DeleteInterceptEndpointGroupRequest 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.networksecurity.v1.DeleteInterceptEndpointGroupRequest. 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::networksecurity::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.networksecurity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInterceptEndpointGroup(NoAwaitTag, google::cloud::networksecurity::v1::DeleteInterceptEndpointGroupRequest const &, Options)

Deletes an endpoint group.

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

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

Deletes an endpoint group.

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::networksecurity::v1::OperationMetadata > >

ListInterceptEndpointGroupAssociations(std::string const &, Options)

Lists associations in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent, which owns this collection of associations. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networksecurity::v1::InterceptEndpointGroupAssociation >

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

ListInterceptEndpointGroupAssociations(google::cloud::networksecurity::v1::ListInterceptEndpointGroupAssociationsRequest, Options)

Lists associations in a given project and location.

Parameters
Name Description
request google::cloud::networksecurity::v1::ListInterceptEndpointGroupAssociationsRequest

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.networksecurity.v1.ListInterceptEndpointGroupAssociationsRequest. 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::networksecurity::v1::InterceptEndpointGroupAssociation >

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

GetInterceptEndpointGroupAssociation(std::string const &, Options)

Gets a specific association.

Parameters
Name Description
name std::string const &

Required. The name of the association to retrieve. Format: projects/{project}/locations/{location}/interceptEndpointGroupAssociations/{intercept_endpoint_group_association}

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networksecurity::v1::InterceptEndpointGroupAssociation >

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

GetInterceptEndpointGroupAssociation(google::cloud::networksecurity::v1::GetInterceptEndpointGroupAssociationRequest const &, Options)

Gets a specific association.

Parameters
Name Description
request google::cloud::networksecurity::v1::GetInterceptEndpointGroupAssociationRequest 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.networksecurity.v1.GetInterceptEndpointGroupAssociationRequest. 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::networksecurity::v1::InterceptEndpointGroupAssociation >

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

CreateInterceptEndpointGroupAssociation(std::string const &, google::cloud::networksecurity::v1::InterceptEndpointGroupAssociation const &, std::string const &, Options)

Creates an association in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource where this association will be created. Format: projects/{project}/locations/{location}

intercept_endpoint_group_association google::cloud::networksecurity::v1::InterceptEndpointGroupAssociation const &

Required. The association to create.

intercept_endpoint_group_association_id std::string const &

Optional. The ID to use for the new association, which will become the final component of the endpoint group's resource name. If not provided, the server will generate a unique ID.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::v1::InterceptEndpointGroupAssociation > >

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

CreateInterceptEndpointGroupAssociation(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::InterceptEndpointGroupAssociation const &, std::string const &, Options)

Creates an association 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 &
intercept_endpoint_group_association google::cloud::networksecurity::v1::InterceptEndpointGroupAssociation const &
intercept_endpoint_group_association_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateInterceptEndpointGroupAssociation(google::cloud::networksecurity::v1::CreateInterceptEndpointGroupAssociationRequest const &, Options)

Creates an association in a given project and location.

Parameters
Name Description
request google::cloud::networksecurity::v1::CreateInterceptEndpointGroupAssociationRequest 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.networksecurity.v1.CreateInterceptEndpointGroupAssociationRequest. 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::networksecurity::v1::InterceptEndpointGroupAssociation > >

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

CreateInterceptEndpointGroupAssociation(NoAwaitTag, google::cloud::networksecurity::v1::CreateInterceptEndpointGroupAssociationRequest const &, Options)

Creates an association 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::networksecurity::v1::CreateInterceptEndpointGroupAssociationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates an association 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::networksecurity::v1::InterceptEndpointGroupAssociation > >

UpdateInterceptEndpointGroupAssociation(google::cloud::networksecurity::v1::InterceptEndpointGroupAssociation const &, google::protobuf::FieldMask const &, Options)

Updates an association.

Parameters
Name Description
intercept_endpoint_group_association google::cloud::networksecurity::v1::InterceptEndpointGroupAssociation const &

Required. The association to update.

update_mask google::protobuf::FieldMask const &

Optional. The list of fields to update. Fields are specified relative to the association (e.g. description; notintercept_endpoint_group_association.description). See https://google.aip.dev/161 for more details.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::v1::InterceptEndpointGroupAssociation > >

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

UpdateInterceptEndpointGroupAssociation(NoAwaitTag, google::cloud::networksecurity::v1::InterceptEndpointGroupAssociation const &, google::protobuf::FieldMask const &, Options)

Updates an association.

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

UpdateInterceptEndpointGroupAssociation(google::cloud::networksecurity::v1::UpdateInterceptEndpointGroupAssociationRequest const &, Options)

Updates an association.

Parameters
Name Description
request google::cloud::networksecurity::v1::UpdateInterceptEndpointGroupAssociationRequest 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.networksecurity.v1.UpdateInterceptEndpointGroupAssociationRequest. 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::networksecurity::v1::InterceptEndpointGroupAssociation > >

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

UpdateInterceptEndpointGroupAssociation(NoAwaitTag, google::cloud::networksecurity::v1::UpdateInterceptEndpointGroupAssociationRequest const &, Options)

Updates an association.

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

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

Updates an association.

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::networksecurity::v1::InterceptEndpointGroupAssociation > >

DeleteInterceptEndpointGroupAssociation(std::string const &, Options)

Deletes an association.

Parameters
Name Description
name std::string const &

Required. The association to delete.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::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.networksecurity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes an association.

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 >

DeleteInterceptEndpointGroupAssociation(google::cloud::networksecurity::v1::DeleteInterceptEndpointGroupAssociationRequest const &, Options)

Deletes an association.

Parameters
Name Description
request google::cloud::networksecurity::v1::DeleteInterceptEndpointGroupAssociationRequest 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.networksecurity.v1.DeleteInterceptEndpointGroupAssociationRequest. 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::networksecurity::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.networksecurity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInterceptEndpointGroupAssociation(NoAwaitTag, google::cloud::networksecurity::v1::DeleteInterceptEndpointGroupAssociationRequest const &, Options)

Deletes an association.

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

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

Deletes an association.

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::networksecurity::v1::OperationMetadata > >

ListInterceptDeploymentGroups(std::string const &, Options)

Lists deployment groups in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent, which owns this collection of deployment groups. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networksecurity::v1::InterceptDeploymentGroup >

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

ListInterceptDeploymentGroups(google::cloud::networksecurity::v1::ListInterceptDeploymentGroupsRequest, Options)

Lists deployment groups in a given project and location.

Parameters
Name Description
request google::cloud::networksecurity::v1::ListInterceptDeploymentGroupsRequest

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.networksecurity.v1.ListInterceptDeploymentGroupsRequest. 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::networksecurity::v1::InterceptDeploymentGroup >

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

GetInterceptDeploymentGroup(std::string const &, Options)

Gets a specific deployment group.

Parameters
Name Description
name std::string const &

Required. The name of the deployment group to retrieve. Format: projects/{project}/locations/{location}/interceptDeploymentGroups/{intercept_deployment_group}

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networksecurity::v1::InterceptDeploymentGroup >

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

GetInterceptDeploymentGroup(google::cloud::networksecurity::v1::GetInterceptDeploymentGroupRequest const &, Options)

Gets a specific deployment group.

Parameters
Name Description
request google::cloud::networksecurity::v1::GetInterceptDeploymentGroupRequest 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.networksecurity.v1.GetInterceptDeploymentGroupRequest. 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::networksecurity::v1::InterceptDeploymentGroup >

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

CreateInterceptDeploymentGroup(std::string const &, google::cloud::networksecurity::v1::InterceptDeploymentGroup const &, std::string const &, Options)

Creates a deployment group in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource where this deployment group will be created. Format: projects/{project}/locations/{location}

intercept_deployment_group google::cloud::networksecurity::v1::InterceptDeploymentGroup const &

Required. The deployment group to create.

intercept_deployment_group_id std::string const &

Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::v1::InterceptDeploymentGroup > >

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

CreateInterceptDeploymentGroup(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::InterceptDeploymentGroup const &, std::string const &, Options)

Creates a deployment group 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 &
intercept_deployment_group google::cloud::networksecurity::v1::InterceptDeploymentGroup const &
intercept_deployment_group_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateInterceptDeploymentGroup(google::cloud::networksecurity::v1::CreateInterceptDeploymentGroupRequest const &, Options)

Creates a deployment group in a given project and location.

Parameters
Name Description
request google::cloud::networksecurity::v1::CreateInterceptDeploymentGroupRequest 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.networksecurity.v1.CreateInterceptDeploymentGroupRequest. 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::networksecurity::v1::InterceptDeploymentGroup > >

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

CreateInterceptDeploymentGroup(NoAwaitTag, google::cloud::networksecurity::v1::CreateInterceptDeploymentGroupRequest const &, Options)

Creates a deployment group 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::networksecurity::v1::CreateInterceptDeploymentGroupRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a deployment group 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::networksecurity::v1::InterceptDeploymentGroup > >

UpdateInterceptDeploymentGroup(google::cloud::networksecurity::v1::InterceptDeploymentGroup const &, google::protobuf::FieldMask const &, Options)

Updates a deployment group.

Parameters
Name Description
intercept_deployment_group google::cloud::networksecurity::v1::InterceptDeploymentGroup const &

Required. The deployment group to update.

update_mask google::protobuf::FieldMask const &

Optional. The list of fields to update. Fields are specified relative to the deployment group (e.g. description; notintercept_deployment_group.description). See https://google.aip.dev/161 for more details.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::v1::InterceptDeploymentGroup > >

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

UpdateInterceptDeploymentGroup(NoAwaitTag, google::cloud::networksecurity::v1::InterceptDeploymentGroup const &, google::protobuf::FieldMask const &, Options)

Updates a deployment group.

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

UpdateInterceptDeploymentGroup(google::cloud::networksecurity::v1::UpdateInterceptDeploymentGroupRequest const &, Options)

Updates a deployment group.

Parameters
Name Description
request google::cloud::networksecurity::v1::UpdateInterceptDeploymentGroupRequest 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.networksecurity.v1.UpdateInterceptDeploymentGroupRequest. 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::networksecurity::v1::InterceptDeploymentGroup > >

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

UpdateInterceptDeploymentGroup(NoAwaitTag, google::cloud::networksecurity::v1::UpdateInterceptDeploymentGroupRequest const &, Options)

Updates a deployment group.

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

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

Updates a deployment group.

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::networksecurity::v1::InterceptDeploymentGroup > >

DeleteInterceptDeploymentGroup(std::string const &, Options)

Deletes a deployment group.

Parameters
Name Description
name std::string const &

Required. The deployment group to delete.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::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.networksecurity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a deployment group.

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 >

DeleteInterceptDeploymentGroup(google::cloud::networksecurity::v1::DeleteInterceptDeploymentGroupRequest const &, Options)

Deletes a deployment group.

Parameters
Name Description
request google::cloud::networksecurity::v1::DeleteInterceptDeploymentGroupRequest 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.networksecurity.v1.DeleteInterceptDeploymentGroupRequest. 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::networksecurity::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.networksecurity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInterceptDeploymentGroup(NoAwaitTag, google::cloud::networksecurity::v1::DeleteInterceptDeploymentGroupRequest const &, Options)

Deletes a deployment group.

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

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

Deletes a deployment group.

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::networksecurity::v1::OperationMetadata > >

ListInterceptDeployments(std::string const &, Options)

Lists deployments in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent, which owns this collection of deployments. Example: projects/123456789/locations/us-central1-a. See https://google.aip.dev/132 for more details.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networksecurity::v1::InterceptDeployment >

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

ListInterceptDeployments(google::cloud::networksecurity::v1::ListInterceptDeploymentsRequest, Options)

Lists deployments in a given project and location.

Parameters
Name Description
request google::cloud::networksecurity::v1::ListInterceptDeploymentsRequest

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.networksecurity.v1.ListInterceptDeploymentsRequest. 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::networksecurity::v1::InterceptDeployment >

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

GetInterceptDeployment(std::string const &, Options)

Gets a specific deployment.

Parameters
Name Description
name std::string const &

Required. The name of the deployment to retrieve. Format: projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networksecurity::v1::InterceptDeployment >

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

GetInterceptDeployment(google::cloud::networksecurity::v1::GetInterceptDeploymentRequest const &, Options)

Gets a specific deployment.

Parameters
Name Description
request google::cloud::networksecurity::v1::GetInterceptDeploymentRequest 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.networksecurity.v1.GetInterceptDeploymentRequest. 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::networksecurity::v1::InterceptDeployment >

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

CreateInterceptDeployment(std::string const &, google::cloud::networksecurity::v1::InterceptDeployment const &, std::string const &, Options)

Creates a deployment in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource where this deployment will be created. Format: projects/{project}/locations/{location}

intercept_deployment google::cloud::networksecurity::v1::InterceptDeployment const &

Required. The deployment to create.

intercept_deployment_id std::string const &

Required. The ID to use for the new deployment, which will become the final component of the deployment's resource name.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::v1::InterceptDeployment > >

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

CreateInterceptDeployment(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::InterceptDeployment const &, std::string const &, Options)

Creates a deployment 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 &
intercept_deployment google::cloud::networksecurity::v1::InterceptDeployment const &
intercept_deployment_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateInterceptDeployment(google::cloud::networksecurity::v1::CreateInterceptDeploymentRequest const &, Options)

Creates a deployment in a given project and location.

Parameters
Name Description
request google::cloud::networksecurity::v1::CreateInterceptDeploymentRequest 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.networksecurity.v1.CreateInterceptDeploymentRequest. 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::networksecurity::v1::InterceptDeployment > >

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

CreateInterceptDeployment(NoAwaitTag, google::cloud::networksecurity::v1::CreateInterceptDeploymentRequest const &, Options)

Creates a deployment 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::networksecurity::v1::CreateInterceptDeploymentRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a deployment 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::networksecurity::v1::InterceptDeployment > >

UpdateInterceptDeployment(google::cloud::networksecurity::v1::InterceptDeployment const &, google::protobuf::FieldMask const &, Options)

Updates a deployment.

Parameters
Name Description
intercept_deployment google::cloud::networksecurity::v1::InterceptDeployment const &

Required. The deployment to update.

update_mask google::protobuf::FieldMask const &

Optional. The list of fields to update. Fields are specified relative to the deployment (e.g. description; notintercept_deployment.description). See https://google.aip.dev/161 for more details.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::v1::InterceptDeployment > >

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

UpdateInterceptDeployment(NoAwaitTag, google::cloud::networksecurity::v1::InterceptDeployment const &, google::protobuf::FieldMask const &, Options)

Updates a deployment.

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

UpdateInterceptDeployment(google::cloud::networksecurity::v1::UpdateInterceptDeploymentRequest const &, Options)

Updates a deployment.

Parameters
Name Description
request google::cloud::networksecurity::v1::UpdateInterceptDeploymentRequest 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.networksecurity.v1.UpdateInterceptDeploymentRequest. 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::networksecurity::v1::InterceptDeployment > >

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

UpdateInterceptDeployment(NoAwaitTag, google::cloud::networksecurity::v1::UpdateInterceptDeploymentRequest const &, Options)

Updates a deployment.

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

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

Updates a deployment.

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::networksecurity::v1::InterceptDeployment > >

DeleteInterceptDeployment(std::string const &, Options)

Deletes a deployment.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networksecurity::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.networksecurity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a deployment.

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 >

DeleteInterceptDeployment(google::cloud::networksecurity::v1::DeleteInterceptDeploymentRequest const &, Options)

Deletes a deployment.

Parameters
Name Description
request google::cloud::networksecurity::v1::DeleteInterceptDeploymentRequest 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.networksecurity.v1.DeleteInterceptDeploymentRequest. 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::networksecurity::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.networksecurity.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInterceptDeployment(NoAwaitTag, google::cloud::networksecurity::v1::DeleteInterceptDeploymentRequest const &, Options)

Deletes a deployment.

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

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

Deletes a deployment.

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::networksecurity::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.