Class MirroringClient (3.7.0-rc)

PM2 is the "out-of-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

MirroringClient(MirroringClient const &)

Copy and move support

Parameter
Name Description
MirroringClient const &

MirroringClient(MirroringClient &&)

Copy and move support

Parameter
Name Description
MirroringClient &&

MirroringClient(std::shared_ptr< MirroringConnection >, Options)

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

Operators

operator=(MirroringClient const &)

Copy and move support

Parameter
Name Description
MirroringClient const &
Returns
Type Description
MirroringClient &

operator=(MirroringClient &&)

Copy and move support

Parameter
Name Description
MirroringClient &&
Returns
Type Description
MirroringClient &

Functions

ListMirroringEndpointGroups(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::MirroringEndpointGroup >

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

ListMirroringEndpointGroups(google::cloud::networksecurity::v1::ListMirroringEndpointGroupsRequest, Options)

Lists endpoint groups in a given project and location.

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

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.ListMirroringEndpointGroupsRequest. 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::MirroringEndpointGroup >

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

GetMirroringEndpointGroup(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}/mirroringEndpointGroups/{mirroring_endpoint_group}

opts Options

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

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

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

GetMirroringEndpointGroup(google::cloud::networksecurity::v1::GetMirroringEndpointGroupRequest const &, Options)

Gets a specific endpoint group.

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

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

CreateMirroringEndpointGroup(std::string const &, google::cloud::networksecurity::v1::MirroringEndpointGroup 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}

mirroring_endpoint_group google::cloud::networksecurity::v1::MirroringEndpointGroup const &

Required. The endpoint group to create.

mirroring_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::MirroringEndpointGroup > >

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

CreateMirroringEndpointGroup(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::MirroringEndpointGroup 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 &
mirroring_endpoint_group google::cloud::networksecurity::v1::MirroringEndpointGroup const &
mirroring_endpoint_group_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateMirroringEndpointGroup(google::cloud::networksecurity::v1::CreateMirroringEndpointGroupRequest const &, Options)

Creates an endpoint group in a given project and location.

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

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

CreateMirroringEndpointGroup(NoAwaitTag, google::cloud::networksecurity::v1::CreateMirroringEndpointGroupRequest 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::CreateMirroringEndpointGroupRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateMirroringEndpointGroup(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::MirroringEndpointGroup > >

UpdateMirroringEndpointGroup(google::cloud::networksecurity::v1::MirroringEndpointGroup const &, google::protobuf::FieldMask const &, Options)

Updates an endpoint group.

Parameters
Name Description
mirroring_endpoint_group google::cloud::networksecurity::v1::MirroringEndpointGroup 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; notmirroring_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::MirroringEndpointGroup > >

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

UpdateMirroringEndpointGroup(NoAwaitTag, google::cloud::networksecurity::v1::MirroringEndpointGroup 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
mirroring_endpoint_group google::cloud::networksecurity::v1::MirroringEndpointGroup const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateMirroringEndpointGroup(google::cloud::networksecurity::v1::UpdateMirroringEndpointGroupRequest const &, Options)

Updates an endpoint group.

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

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

UpdateMirroringEndpointGroup(NoAwaitTag, google::cloud::networksecurity::v1::UpdateMirroringEndpointGroupRequest 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::UpdateMirroringEndpointGroupRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateMirroringEndpointGroup(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::MirroringEndpointGroup > >

DeleteMirroringEndpointGroup(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.

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

DeleteMirroringEndpointGroup(google::cloud::networksecurity::v1::DeleteMirroringEndpointGroupRequest const &, Options)

Deletes an endpoint group.

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

DeleteMirroringEndpointGroup(NoAwaitTag, google::cloud::networksecurity::v1::DeleteMirroringEndpointGroupRequest 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::DeleteMirroringEndpointGroupRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

ListMirroringEndpointGroupAssociations(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::MirroringEndpointGroupAssociation >

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

ListMirroringEndpointGroupAssociations(google::cloud::networksecurity::v1::ListMirroringEndpointGroupAssociationsRequest, Options)

Lists associations in a given project and location.

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

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.ListMirroringEndpointGroupAssociationsRequest. 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::MirroringEndpointGroupAssociation >

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

GetMirroringEndpointGroupAssociation(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}/mirroringEndpointGroupAssociations/{mirroring_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::MirroringEndpointGroupAssociation >

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

GetMirroringEndpointGroupAssociation(google::cloud::networksecurity::v1::GetMirroringEndpointGroupAssociationRequest const &, Options)

Gets a specific association.

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

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

CreateMirroringEndpointGroupAssociation(std::string const &, google::cloud::networksecurity::v1::MirroringEndpointGroupAssociation 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}

mirroring_endpoint_group_association google::cloud::networksecurity::v1::MirroringEndpointGroupAssociation const &

Required. The association to create.

mirroring_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::MirroringEndpointGroupAssociation > >

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

CreateMirroringEndpointGroupAssociation(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::MirroringEndpointGroupAssociation 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 &
mirroring_endpoint_group_association google::cloud::networksecurity::v1::MirroringEndpointGroupAssociation const &
mirroring_endpoint_group_association_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateMirroringEndpointGroupAssociation(google::cloud::networksecurity::v1::CreateMirroringEndpointGroupAssociationRequest const &, Options)

Creates an association in a given project and location.

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

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

CreateMirroringEndpointGroupAssociation(NoAwaitTag, google::cloud::networksecurity::v1::CreateMirroringEndpointGroupAssociationRequest 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::CreateMirroringEndpointGroupAssociationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateMirroringEndpointGroupAssociation(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::MirroringEndpointGroupAssociation > >

UpdateMirroringEndpointGroupAssociation(google::cloud::networksecurity::v1::MirroringEndpointGroupAssociation const &, google::protobuf::FieldMask const &, Options)

Updates an association.

Parameters
Name Description
mirroring_endpoint_group_association google::cloud::networksecurity::v1::MirroringEndpointGroupAssociation 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; notmirroring_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::MirroringEndpointGroupAssociation > >

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

UpdateMirroringEndpointGroupAssociation(NoAwaitTag, google::cloud::networksecurity::v1::MirroringEndpointGroupAssociation 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
mirroring_endpoint_group_association google::cloud::networksecurity::v1::MirroringEndpointGroupAssociation const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateMirroringEndpointGroupAssociation(google::cloud::networksecurity::v1::UpdateMirroringEndpointGroupAssociationRequest const &, Options)

Updates an association.

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

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

UpdateMirroringEndpointGroupAssociation(NoAwaitTag, google::cloud::networksecurity::v1::UpdateMirroringEndpointGroupAssociationRequest 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::UpdateMirroringEndpointGroupAssociationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateMirroringEndpointGroupAssociation(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::MirroringEndpointGroupAssociation > >

DeleteMirroringEndpointGroupAssociation(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.

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

DeleteMirroringEndpointGroupAssociation(google::cloud::networksecurity::v1::DeleteMirroringEndpointGroupAssociationRequest const &, Options)

Deletes an association.

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

DeleteMirroringEndpointGroupAssociation(NoAwaitTag, google::cloud::networksecurity::v1::DeleteMirroringEndpointGroupAssociationRequest 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::DeleteMirroringEndpointGroupAssociationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

ListMirroringDeploymentGroups(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::MirroringDeploymentGroup >

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

ListMirroringDeploymentGroups(google::cloud::networksecurity::v1::ListMirroringDeploymentGroupsRequest, Options)

Lists deployment groups in a given project and location.

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

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.ListMirroringDeploymentGroupsRequest. 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::MirroringDeploymentGroup >

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

GetMirroringDeploymentGroup(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}/mirroringDeploymentGroups/{mirroring_deployment_group}

opts Options

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

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

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

GetMirroringDeploymentGroup(google::cloud::networksecurity::v1::GetMirroringDeploymentGroupRequest const &, Options)

Gets a specific deployment group.

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

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

CreateMirroringDeploymentGroup(std::string const &, google::cloud::networksecurity::v1::MirroringDeploymentGroup 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}

mirroring_deployment_group google::cloud::networksecurity::v1::MirroringDeploymentGroup const &

Required. The deployment group to create.

mirroring_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::MirroringDeploymentGroup > >

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

CreateMirroringDeploymentGroup(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::MirroringDeploymentGroup 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 &
mirroring_deployment_group google::cloud::networksecurity::v1::MirroringDeploymentGroup const &
mirroring_deployment_group_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateMirroringDeploymentGroup(google::cloud::networksecurity::v1::CreateMirroringDeploymentGroupRequest const &, Options)

Creates a deployment group in a given project and location.

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

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

CreateMirroringDeploymentGroup(NoAwaitTag, google::cloud::networksecurity::v1::CreateMirroringDeploymentGroupRequest 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::CreateMirroringDeploymentGroupRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateMirroringDeploymentGroup(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::MirroringDeploymentGroup > >

UpdateMirroringDeploymentGroup(google::cloud::networksecurity::v1::MirroringDeploymentGroup const &, google::protobuf::FieldMask const &, Options)

Updates a deployment group.

Parameters
Name Description
mirroring_deployment_group google::cloud::networksecurity::v1::MirroringDeploymentGroup 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; notmirroring_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::MirroringDeploymentGroup > >

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

UpdateMirroringDeploymentGroup(NoAwaitTag, google::cloud::networksecurity::v1::MirroringDeploymentGroup 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
mirroring_deployment_group google::cloud::networksecurity::v1::MirroringDeploymentGroup const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateMirroringDeploymentGroup(google::cloud::networksecurity::v1::UpdateMirroringDeploymentGroupRequest const &, Options)

Updates a deployment group.

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

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

UpdateMirroringDeploymentGroup(NoAwaitTag, google::cloud::networksecurity::v1::UpdateMirroringDeploymentGroupRequest 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::UpdateMirroringDeploymentGroupRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateMirroringDeploymentGroup(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::MirroringDeploymentGroup > >

DeleteMirroringDeploymentGroup(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.

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

DeleteMirroringDeploymentGroup(google::cloud::networksecurity::v1::DeleteMirroringDeploymentGroupRequest const &, Options)

Deletes a deployment group.

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

DeleteMirroringDeploymentGroup(NoAwaitTag, google::cloud::networksecurity::v1::DeleteMirroringDeploymentGroupRequest 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::DeleteMirroringDeploymentGroupRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

ListMirroringDeployments(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::MirroringDeployment >

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

ListMirroringDeployments(google::cloud::networksecurity::v1::ListMirroringDeploymentsRequest, Options)

Lists deployments in a given project and location.

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

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.ListMirroringDeploymentsRequest. 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::MirroringDeployment >

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

GetMirroringDeployment(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}/mirroringDeployments/{mirroring_deployment}

opts Options

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

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

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

GetMirroringDeployment(google::cloud::networksecurity::v1::GetMirroringDeploymentRequest const &, Options)

Gets a specific deployment.

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

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

CreateMirroringDeployment(std::string const &, google::cloud::networksecurity::v1::MirroringDeployment 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}

mirroring_deployment google::cloud::networksecurity::v1::MirroringDeployment const &

Required. The deployment to create.

mirroring_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::MirroringDeployment > >

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

CreateMirroringDeployment(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::MirroringDeployment 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 &
mirroring_deployment google::cloud::networksecurity::v1::MirroringDeployment const &
mirroring_deployment_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateMirroringDeployment(google::cloud::networksecurity::v1::CreateMirroringDeploymentRequest const &, Options)

Creates a deployment in a given project and location.

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

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

CreateMirroringDeployment(NoAwaitTag, google::cloud::networksecurity::v1::CreateMirroringDeploymentRequest 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::CreateMirroringDeploymentRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateMirroringDeployment(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::MirroringDeployment > >

UpdateMirroringDeployment(google::cloud::networksecurity::v1::MirroringDeployment const &, google::protobuf::FieldMask const &, Options)

Updates a deployment.

Parameters
Name Description
mirroring_deployment google::cloud::networksecurity::v1::MirroringDeployment 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; notmirroring_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::MirroringDeployment > >

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

UpdateMirroringDeployment(NoAwaitTag, google::cloud::networksecurity::v1::MirroringDeployment 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
mirroring_deployment google::cloud::networksecurity::v1::MirroringDeployment const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateMirroringDeployment(google::cloud::networksecurity::v1::UpdateMirroringDeploymentRequest const &, Options)

Updates a deployment.

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

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

UpdateMirroringDeployment(NoAwaitTag, google::cloud::networksecurity::v1::UpdateMirroringDeploymentRequest 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::UpdateMirroringDeploymentRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateMirroringDeployment(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::MirroringDeployment > >

DeleteMirroringDeployment(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.

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

DeleteMirroringDeployment(google::cloud::networksecurity::v1::DeleteMirroringDeploymentRequest const &, Options)

Deletes a deployment.

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

DeleteMirroringDeployment(NoAwaitTag, google::cloud::networksecurity::v1::DeleteMirroringDeploymentRequest 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::DeleteMirroringDeploymentRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteMirroringDeployment(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.