Class NetworkSecurityClient (3.7.0-rc)

Network Security API provides resources to configure authentication and authorization policies.

Refer to per API resource documentation for more information.

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

NetworkSecurityClient(NetworkSecurityClient const &)

Copy and move support

Parameter
Name Description
NetworkSecurityClient const &

NetworkSecurityClient(NetworkSecurityClient &&)

Copy and move support

Parameter
Name Description
NetworkSecurityClient &&

NetworkSecurityClient(std::shared_ptr< NetworkSecurityConnection >, Options)

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

Operators

operator=(NetworkSecurityClient const &)

Copy and move support

Parameter
Name Description
NetworkSecurityClient const &
Returns
Type Description
NetworkSecurityClient &

operator=(NetworkSecurityClient &&)

Copy and move support

Parameter
Name Description
NetworkSecurityClient &&
Returns
Type Description
NetworkSecurityClient &

Functions

ListAuthorizationPolicies(std::string const &, Options)

Lists AuthorizationPolicies in a given project and location.

Parameters
Name Description
parent std::string const &

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

opts Options

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

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

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

ListAuthorizationPolicies(google::cloud::networksecurity::v1::ListAuthorizationPoliciesRequest, Options)

Lists AuthorizationPolicies in a given project and location.

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

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.ListAuthorizationPoliciesRequest. 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::AuthorizationPolicy >

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

GetAuthorizationPolicy(std::string const &, Options)

Gets details of a single AuthorizationPolicy.

Parameters
Name Description
name std::string const &

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

opts Options

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

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

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

GetAuthorizationPolicy(google::cloud::networksecurity::v1::GetAuthorizationPolicyRequest const &, Options)

Gets details of a single AuthorizationPolicy.

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

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

CreateAuthorizationPolicy(std::string const &, google::cloud::networksecurity::v1::AuthorizationPolicy const &, std::string const &, Options)

Creates a new AuthorizationPolicy in a given project and location.

Parameters
Name Description
parent std::string const &

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

authorization_policy google::cloud::networksecurity::v1::AuthorizationPolicy const &

Required. AuthorizationPolicy resource to be created.

authorization_policy_id std::string const &

Required. Short name of the AuthorizationPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".

opts Options

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

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

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

CreateAuthorizationPolicy(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::AuthorizationPolicy const &, std::string const &, Options)

Creates a new AuthorizationPolicy 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 &
authorization_policy google::cloud::networksecurity::v1::AuthorizationPolicy const &
authorization_policy_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateAuthorizationPolicy(google::cloud::networksecurity::v1::CreateAuthorizationPolicyRequest const &, Options)

Creates a new AuthorizationPolicy in a given project and location.

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

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

CreateAuthorizationPolicy(NoAwaitTag, google::cloud::networksecurity::v1::CreateAuthorizationPolicyRequest const &, Options)

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

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

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

UpdateAuthorizationPolicy(google::cloud::networksecurity::v1::AuthorizationPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single AuthorizationPolicy.

Parameters
Name Description
authorization_policy google::cloud::networksecurity::v1::AuthorizationPolicy const &

Required. Updated AuthorizationPolicy resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the AuthorizationPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

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

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

UpdateAuthorizationPolicy(NoAwaitTag, google::cloud::networksecurity::v1::AuthorizationPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single AuthorizationPolicy.

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

UpdateAuthorizationPolicy(google::cloud::networksecurity::v1::UpdateAuthorizationPolicyRequest const &, Options)

Updates the parameters of a single AuthorizationPolicy.

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

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

UpdateAuthorizationPolicy(NoAwaitTag, google::cloud::networksecurity::v1::UpdateAuthorizationPolicyRequest const &, Options)

Updates the parameters of a single AuthorizationPolicy.

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

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

Updates the parameters of a single AuthorizationPolicy.

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

DeleteAuthorizationPolicy(std::string const &, Options)

Deletes a single AuthorizationPolicy.

Parameters
Name Description
name std::string const &

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

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.

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

Deletes a single AuthorizationPolicy.

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 >

DeleteAuthorizationPolicy(google::cloud::networksecurity::v1::DeleteAuthorizationPolicyRequest const &, Options)

Deletes a single AuthorizationPolicy.

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

DeleteAuthorizationPolicy(NoAwaitTag, google::cloud::networksecurity::v1::DeleteAuthorizationPolicyRequest const &, Options)

Deletes a single AuthorizationPolicy.

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

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

Deletes a single AuthorizationPolicy.

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

ListBackendAuthenticationConfigs(std::string const &, Options)

Lists BackendAuthenticationConfigs in a given project and location.

Parameters
Name Description
parent std::string const &

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

opts Options

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

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

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

ListBackendAuthenticationConfigs(google::cloud::networksecurity::v1::ListBackendAuthenticationConfigsRequest, Options)

Lists BackendAuthenticationConfigs in a given project and location.

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

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.ListBackendAuthenticationConfigsRequest. 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::BackendAuthenticationConfig >

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

GetBackendAuthenticationConfig(std::string const &, Options)

Gets details of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

Parameters
Name Description
name std::string const &

Required. A name of the BackendAuthenticationConfig to get. Must be in the format projects/*/locations/{location}/backendAuthenticationConfigs/*.

opts Options

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

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

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

GetBackendAuthenticationConfig(google::cloud::networksecurity::v1::GetBackendAuthenticationConfigRequest const &, Options)

Gets details of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

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

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

CreateBackendAuthenticationConfig(std::string const &, google::cloud::networksecurity::v1::BackendAuthenticationConfig const &, std::string const &, Options)

Creates a new BackendAuthenticationConfig in a given project and location.

Parameters
Name Description
parent std::string const &

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

backend_authentication_config google::cloud::networksecurity::v1::BackendAuthenticationConfig const &

Required. BackendAuthenticationConfig resource to be created.

backend_authentication_config_id std::string const &

Required. Short name of the BackendAuthenticationConfig resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "backend-auth-config".

opts Options

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

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

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

CreateBackendAuthenticationConfig(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::BackendAuthenticationConfig const &, std::string const &, Options)

Creates a new BackendAuthenticationConfig 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 &
backend_authentication_config google::cloud::networksecurity::v1::BackendAuthenticationConfig const &
backend_authentication_config_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateBackendAuthenticationConfig(google::cloud::networksecurity::v1::CreateBackendAuthenticationConfigRequest const &, Options)

Creates a new BackendAuthenticationConfig in a given project and location.

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

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

CreateBackendAuthenticationConfig(NoAwaitTag, google::cloud::networksecurity::v1::CreateBackendAuthenticationConfigRequest const &, Options)

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

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

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

UpdateBackendAuthenticationConfig(google::cloud::networksecurity::v1::BackendAuthenticationConfig const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

Parameters
Name Description
backend_authentication_config google::cloud::networksecurity::v1::BackendAuthenticationConfig const &

Required. Updated BackendAuthenticationConfig resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the BackendAuthenticationConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

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

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

UpdateBackendAuthenticationConfig(NoAwaitTag, google::cloud::networksecurity::v1::BackendAuthenticationConfig const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

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

UpdateBackendAuthenticationConfig(google::cloud::networksecurity::v1::UpdateBackendAuthenticationConfigRequest const &, Options)

Updates the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

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

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

UpdateBackendAuthenticationConfig(NoAwaitTag, google::cloud::networksecurity::v1::UpdateBackendAuthenticationConfigRequest const &, Options)

Updates the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

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

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

Updates the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

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

DeleteBackendAuthenticationConfig(std::string const &, Options)

Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig.

Parameters
Name Description
name std::string const &

Required. A name of the BackendAuthenticationConfig to delete. Must be in the format projects/*/locations/{location}/backendAuthenticationConfigs/*.

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.

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

Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig.

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 >

DeleteBackendAuthenticationConfig(google::cloud::networksecurity::v1::DeleteBackendAuthenticationConfigRequest const &, Options)

Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig.

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

DeleteBackendAuthenticationConfig(NoAwaitTag, google::cloud::networksecurity::v1::DeleteBackendAuthenticationConfigRequest const &, Options)

Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig.

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

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

Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig.

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

ListServerTlsPolicies(std::string const &, Options)

Lists ServerTlsPolicies in a given project and location.

Parameters
Name Description
parent std::string const &

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

opts Options

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

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

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

ListServerTlsPolicies(google::cloud::networksecurity::v1::ListServerTlsPoliciesRequest, Options)

Lists ServerTlsPolicies in a given project and location.

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

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.ListServerTlsPoliciesRequest. 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::ServerTlsPolicy >

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

GetServerTlsPolicy(std::string const &, Options)

Gets details of a single ServerTlsPolicy.

Parameters
Name Description
name std::string const &

Required. A name of the ServerTlsPolicy to get. Must be in the format projects/*/locations/{location}/serverTlsPolicies/*.

opts Options

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

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

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

GetServerTlsPolicy(google::cloud::networksecurity::v1::GetServerTlsPolicyRequest const &, Options)

Gets details of a single ServerTlsPolicy.

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

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

CreateServerTlsPolicy(std::string const &, google::cloud::networksecurity::v1::ServerTlsPolicy const &, std::string const &, Options)

Creates a new ServerTlsPolicy in a given project and location.

Parameters
Name Description
parent std::string const &

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

server_tls_policy google::cloud::networksecurity::v1::ServerTlsPolicy const &

Required. ServerTlsPolicy resource to be created.

server_tls_policy_id std::string const &

Required. Short name of the ServerTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "server_mtls_policy".

opts Options

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

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

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

CreateServerTlsPolicy(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::ServerTlsPolicy const &, std::string const &, Options)

Creates a new ServerTlsPolicy 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 &
server_tls_policy google::cloud::networksecurity::v1::ServerTlsPolicy const &
server_tls_policy_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateServerTlsPolicy(google::cloud::networksecurity::v1::CreateServerTlsPolicyRequest const &, Options)

Creates a new ServerTlsPolicy in a given project and location.

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

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

CreateServerTlsPolicy(NoAwaitTag, google::cloud::networksecurity::v1::CreateServerTlsPolicyRequest const &, Options)

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

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

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

UpdateServerTlsPolicy(google::cloud::networksecurity::v1::ServerTlsPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ServerTlsPolicy.

Parameters
Name Description
server_tls_policy google::cloud::networksecurity::v1::ServerTlsPolicy const &

Required. Updated ServerTlsPolicy resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the ServerTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

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

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

UpdateServerTlsPolicy(NoAwaitTag, google::cloud::networksecurity::v1::ServerTlsPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ServerTlsPolicy.

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

UpdateServerTlsPolicy(google::cloud::networksecurity::v1::UpdateServerTlsPolicyRequest const &, Options)

Updates the parameters of a single ServerTlsPolicy.

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

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

UpdateServerTlsPolicy(NoAwaitTag, google::cloud::networksecurity::v1::UpdateServerTlsPolicyRequest const &, Options)

Updates the parameters of a single ServerTlsPolicy.

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

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

Updates the parameters of a single ServerTlsPolicy.

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

DeleteServerTlsPolicy(std::string const &, Options)

Deletes a single ServerTlsPolicy.

Parameters
Name Description
name std::string const &

Required. A name of the ServerTlsPolicy to delete. Must be in the format projects/*/locations/{location}/serverTlsPolicies/*.

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.

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

Deletes a single ServerTlsPolicy.

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 >

DeleteServerTlsPolicy(google::cloud::networksecurity::v1::DeleteServerTlsPolicyRequest const &, Options)

Deletes a single ServerTlsPolicy.

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

DeleteServerTlsPolicy(NoAwaitTag, google::cloud::networksecurity::v1::DeleteServerTlsPolicyRequest const &, Options)

Deletes a single ServerTlsPolicy.

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

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

Deletes a single ServerTlsPolicy.

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

ListClientTlsPolicies(std::string const &, Options)

Lists ClientTlsPolicies in a given project and location.

Parameters
Name Description
parent std::string const &

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

opts Options

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

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

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

ListClientTlsPolicies(google::cloud::networksecurity::v1::ListClientTlsPoliciesRequest, Options)

Lists ClientTlsPolicies in a given project and location.

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

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.ListClientTlsPoliciesRequest. 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::ClientTlsPolicy >

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

GetClientTlsPolicy(std::string const &, Options)

Gets details of a single ClientTlsPolicy.

Parameters
Name Description
name std::string const &

Required. A name of the ClientTlsPolicy to get. Must be in the format projects/*/locations/{location}/clientTlsPolicies/*.

opts Options

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

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

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

GetClientTlsPolicy(google::cloud::networksecurity::v1::GetClientTlsPolicyRequest const &, Options)

Gets details of a single ClientTlsPolicy.

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

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

CreateClientTlsPolicy(std::string const &, google::cloud::networksecurity::v1::ClientTlsPolicy const &, std::string const &, Options)

Creates a new ClientTlsPolicy in a given project and location.

Parameters
Name Description
parent std::string const &

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

client_tls_policy google::cloud::networksecurity::v1::ClientTlsPolicy const &

Required. ClientTlsPolicy resource to be created.

client_tls_policy_id std::string const &

Required. Short name of the ClientTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "client_mtls_policy".

opts Options

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

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

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

CreateClientTlsPolicy(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::ClientTlsPolicy const &, std::string const &, Options)

Creates a new ClientTlsPolicy 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 &
client_tls_policy google::cloud::networksecurity::v1::ClientTlsPolicy const &
client_tls_policy_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateClientTlsPolicy(google::cloud::networksecurity::v1::CreateClientTlsPolicyRequest const &, Options)

Creates a new ClientTlsPolicy in a given project and location.

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

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

CreateClientTlsPolicy(NoAwaitTag, google::cloud::networksecurity::v1::CreateClientTlsPolicyRequest const &, Options)

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

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

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

UpdateClientTlsPolicy(google::cloud::networksecurity::v1::ClientTlsPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ClientTlsPolicy.

Parameters
Name Description
client_tls_policy google::cloud::networksecurity::v1::ClientTlsPolicy const &

Required. Updated ClientTlsPolicy resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the ClientTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

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

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

UpdateClientTlsPolicy(NoAwaitTag, google::cloud::networksecurity::v1::ClientTlsPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ClientTlsPolicy.

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

UpdateClientTlsPolicy(google::cloud::networksecurity::v1::UpdateClientTlsPolicyRequest const &, Options)

Updates the parameters of a single ClientTlsPolicy.

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

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

UpdateClientTlsPolicy(NoAwaitTag, google::cloud::networksecurity::v1::UpdateClientTlsPolicyRequest const &, Options)

Updates the parameters of a single ClientTlsPolicy.

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

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

Updates the parameters of a single ClientTlsPolicy.

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

DeleteClientTlsPolicy(std::string const &, Options)

Deletes a single ClientTlsPolicy.

Parameters
Name Description
name std::string const &

Required. A name of the ClientTlsPolicy to delete. Must be in the format projects/*/locations/{location}/clientTlsPolicies/*.

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.

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

Deletes a single ClientTlsPolicy.

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 >

DeleteClientTlsPolicy(google::cloud::networksecurity::v1::DeleteClientTlsPolicyRequest const &, Options)

Deletes a single ClientTlsPolicy.

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

DeleteClientTlsPolicy(NoAwaitTag, google::cloud::networksecurity::v1::DeleteClientTlsPolicyRequest const &, Options)

Deletes a single ClientTlsPolicy.

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

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

Deletes a single ClientTlsPolicy.

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

ListGatewaySecurityPolicies(std::string const &, Options)

Lists GatewaySecurityPolicies in a given project and location.

Parameters
Name Description
parent std::string const &

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

opts Options

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

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

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

ListGatewaySecurityPolicies(google::cloud::networksecurity::v1::ListGatewaySecurityPoliciesRequest, Options)

Lists GatewaySecurityPolicies in a given project and location.

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

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.ListGatewaySecurityPoliciesRequest. 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::GatewaySecurityPolicy >

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

GetGatewaySecurityPolicy(std::string const &, Options)

Gets details of a single GatewaySecurityPolicy.

Parameters
Name Description
name std::string const &

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

opts Options

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

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

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

GetGatewaySecurityPolicy(google::cloud::networksecurity::v1::GetGatewaySecurityPolicyRequest const &, Options)

Gets details of a single GatewaySecurityPolicy.

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

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

CreateGatewaySecurityPolicy(std::string const &, google::cloud::networksecurity::v1::GatewaySecurityPolicy const &, std::string const &, Options)

Creates a new GatewaySecurityPolicy in a given project and location.

Parameters
Name Description
parent std::string const &

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

gateway_security_policy google::cloud::networksecurity::v1::GatewaySecurityPolicy const &

Required. GatewaySecurityPolicy resource to be created.

gateway_security_policy_id std::string const &

Required. Short name of the GatewaySecurityPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "gateway_security_policy1".

opts Options

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

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

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

CreateGatewaySecurityPolicy(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::GatewaySecurityPolicy const &, std::string const &, Options)

Creates a new GatewaySecurityPolicy in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
gateway_security_policy google::cloud::networksecurity::v1::GatewaySecurityPolicy const &
gateway_security_policy_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateGatewaySecurityPolicy(google::cloud::networksecurity::v1::CreateGatewaySecurityPolicyRequest const &, Options)

Creates a new GatewaySecurityPolicy in a given project and location.

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

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

CreateGatewaySecurityPolicy(NoAwaitTag, google::cloud::networksecurity::v1::CreateGatewaySecurityPolicyRequest const &, Options)

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

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

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

UpdateGatewaySecurityPolicy(google::cloud::networksecurity::v1::GatewaySecurityPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single GatewaySecurityPolicy.

Parameters
Name Description
gateway_security_policy google::cloud::networksecurity::v1::GatewaySecurityPolicy const &

Required. Updated GatewaySecurityPolicy resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the GatewaySecurityPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

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

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

UpdateGatewaySecurityPolicy(NoAwaitTag, google::cloud::networksecurity::v1::GatewaySecurityPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single GatewaySecurityPolicy.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
gateway_security_policy google::cloud::networksecurity::v1::GatewaySecurityPolicy const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateGatewaySecurityPolicy(google::cloud::networksecurity::v1::UpdateGatewaySecurityPolicyRequest const &, Options)

Updates the parameters of a single GatewaySecurityPolicy.

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

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

UpdateGatewaySecurityPolicy(NoAwaitTag, google::cloud::networksecurity::v1::UpdateGatewaySecurityPolicyRequest const &, Options)

Updates the parameters of a single GatewaySecurityPolicy.

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

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

Updates the parameters of a single GatewaySecurityPolicy.

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

DeleteGatewaySecurityPolicy(std::string const &, Options)

Deletes a single GatewaySecurityPolicy.

Parameters
Name Description
name std::string const &

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

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.

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

Deletes a single GatewaySecurityPolicy.

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 >

DeleteGatewaySecurityPolicy(google::cloud::networksecurity::v1::DeleteGatewaySecurityPolicyRequest const &, Options)

Deletes a single GatewaySecurityPolicy.

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

DeleteGatewaySecurityPolicy(NoAwaitTag, google::cloud::networksecurity::v1::DeleteGatewaySecurityPolicyRequest const &, Options)

Deletes a single GatewaySecurityPolicy.

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

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

Deletes a single GatewaySecurityPolicy.

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

ListGatewaySecurityPolicyRules(std::string const &, Options)

Lists GatewaySecurityPolicyRules in a given project and location.

Parameters
Name Description
parent std::string const &

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

opts Options

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

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

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

ListGatewaySecurityPolicyRules(google::cloud::networksecurity::v1::ListGatewaySecurityPolicyRulesRequest, Options)

Lists GatewaySecurityPolicyRules in a given project and location.

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

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.ListGatewaySecurityPolicyRulesRequest. 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::GatewaySecurityPolicyRule >

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

GetGatewaySecurityPolicyRule(std::string const &, Options)

Gets details of a single GatewaySecurityPolicyRule.

Parameters
Name Description
name std::string const &

Required. The name of the GatewaySecurityPolicyRule to retrieve. Format: projects/{project}/location/{location}/gatewaySecurityPolicies//rules/

opts Options

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

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

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

GetGatewaySecurityPolicyRule(google::cloud::networksecurity::v1::GetGatewaySecurityPolicyRuleRequest const &, Options)

Gets details of a single GatewaySecurityPolicyRule.

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

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

CreateGatewaySecurityPolicyRule(std::string const &, google::cloud::networksecurity::v1::GatewaySecurityPolicyRule const &, std::string const &, Options)

Creates a new GatewaySecurityPolicy in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent where this rule will be created. Format : projects/{project}/location/{location}/gatewaySecurityPolicies/*

gateway_security_policy_rule google::cloud::networksecurity::v1::GatewaySecurityPolicyRule const &

Required. The rule to be created.

gateway_security_policy_rule_id std::string const &

The ID to use for the rule, which will become the final component of the rule's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

opts Options

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

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

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

CreateGatewaySecurityPolicyRule(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::GatewaySecurityPolicyRule const &, std::string const &, Options)

Creates a new GatewaySecurityPolicy in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
gateway_security_policy_rule google::cloud::networksecurity::v1::GatewaySecurityPolicyRule const &
gateway_security_policy_rule_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateGatewaySecurityPolicyRule(google::cloud::networksecurity::v1::CreateGatewaySecurityPolicyRuleRequest const &, Options)

Creates a new GatewaySecurityPolicy in a given project and location.

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

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

CreateGatewaySecurityPolicyRule(NoAwaitTag, google::cloud::networksecurity::v1::CreateGatewaySecurityPolicyRuleRequest const &, Options)

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

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

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

UpdateGatewaySecurityPolicyRule(google::cloud::networksecurity::v1::GatewaySecurityPolicyRule const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single GatewaySecurityPolicyRule.

Parameters
Name Description
gateway_security_policy_rule google::cloud::networksecurity::v1::GatewaySecurityPolicyRule const &

Required. Updated GatewaySecurityPolicyRule resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the GatewaySecurityPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

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

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

UpdateGatewaySecurityPolicyRule(NoAwaitTag, google::cloud::networksecurity::v1::GatewaySecurityPolicyRule const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single GatewaySecurityPolicyRule.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
gateway_security_policy_rule google::cloud::networksecurity::v1::GatewaySecurityPolicyRule const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateGatewaySecurityPolicyRule(google::cloud::networksecurity::v1::UpdateGatewaySecurityPolicyRuleRequest const &, Options)

Updates the parameters of a single GatewaySecurityPolicyRule.

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

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

UpdateGatewaySecurityPolicyRule(NoAwaitTag, google::cloud::networksecurity::v1::UpdateGatewaySecurityPolicyRuleRequest const &, Options)

Updates the parameters of a single GatewaySecurityPolicyRule.

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

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

Updates the parameters of a single GatewaySecurityPolicyRule.

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

DeleteGatewaySecurityPolicyRule(std::string const &, Options)

Deletes a single GatewaySecurityPolicyRule.

Parameters
Name Description
name std::string const &

Required. A name of the GatewaySecurityPolicyRule to delete. Must be in the format projects/{project}/locations/{location}/gatewaySecurityPolicies/{gatewaySecurityPolicy}/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.

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

Deletes a single GatewaySecurityPolicyRule.

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 >

DeleteGatewaySecurityPolicyRule(google::cloud::networksecurity::v1::DeleteGatewaySecurityPolicyRuleRequest const &, Options)

Deletes a single GatewaySecurityPolicyRule.

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

DeleteGatewaySecurityPolicyRule(NoAwaitTag, google::cloud::networksecurity::v1::DeleteGatewaySecurityPolicyRuleRequest const &, Options)

Deletes a single GatewaySecurityPolicyRule.

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

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

Deletes a single GatewaySecurityPolicyRule.

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

ListUrlLists(std::string const &, Options)

Lists UrlLists in a given project and location.

Parameters
Name Description
parent std::string const &

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

opts Options

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

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

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

ListUrlLists(google::cloud::networksecurity::v1::ListUrlListsRequest, Options)

Lists UrlLists in a given project and location.

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

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.ListUrlListsRequest. 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::UrlList >

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

GetUrlList(std::string const &, Options)

Gets details of a single UrlList.

Parameters
Name Description
name std::string const &

Required. A name of the UrlList to get. Must be in the format projects/*/locations/{location}/urlLists/*.

opts Options

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

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

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

GetUrlList(google::cloud::networksecurity::v1::GetUrlListRequest const &, Options)

Gets details of a single UrlList.

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

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

CreateUrlList(std::string const &, google::cloud::networksecurity::v1::UrlList const &, std::string const &, Options)

Creates a new UrlList in a given project and location.

Parameters
Name Description
parent std::string const &

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

url_list google::cloud::networksecurity::v1::UrlList const &

Required. UrlList resource to be created.

url_list_id std::string const &

Required. Short name of the UrlList resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "url_list".

opts Options

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

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

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

CreateUrlList(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::UrlList const &, std::string const &, Options)

Creates a new UrlList 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 &
url_list google::cloud::networksecurity::v1::UrlList const &
url_list_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateUrlList(google::cloud::networksecurity::v1::CreateUrlListRequest const &, Options)

Creates a new UrlList in a given project and location.

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

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

CreateUrlList(NoAwaitTag, google::cloud::networksecurity::v1::CreateUrlListRequest const &, Options)

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

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

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

UpdateUrlList(google::cloud::networksecurity::v1::UrlList const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single UrlList.

Parameters
Name Description
url_list google::cloud::networksecurity::v1::UrlList const &

Required. Updated UrlList resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the UrlList resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

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

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

UpdateUrlList(NoAwaitTag, google::cloud::networksecurity::v1::UrlList const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single UrlList.

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

UpdateUrlList(google::cloud::networksecurity::v1::UpdateUrlListRequest const &, Options)

Updates the parameters of a single UrlList.

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

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

UpdateUrlList(NoAwaitTag, google::cloud::networksecurity::v1::UpdateUrlListRequest const &, Options)

Updates the parameters of a single UrlList.

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

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

Updates the parameters of a single UrlList.

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

DeleteUrlList(std::string const &, Options)

Deletes a single UrlList.

Parameters
Name Description
name std::string const &

Required. A name of the UrlList to delete. Must be in the format projects/*/locations/{location}/urlLists/*.

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.

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

Deletes a single UrlList.

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 >

DeleteUrlList(google::cloud::networksecurity::v1::DeleteUrlListRequest const &, Options)

Deletes a single UrlList.

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

DeleteUrlList(NoAwaitTag, google::cloud::networksecurity::v1::DeleteUrlListRequest const &, Options)

Deletes a single UrlList.

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

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

Deletes a single UrlList.

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

ListTlsInspectionPolicies(std::string const &, Options)

Lists TlsInspectionPolicies in a given project and location.

Parameters
Name Description
parent std::string const &

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

opts Options

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

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

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

ListTlsInspectionPolicies(google::cloud::networksecurity::v1::ListTlsInspectionPoliciesRequest, Options)

Lists TlsInspectionPolicies in a given project and location.

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

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.ListTlsInspectionPoliciesRequest. 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::TlsInspectionPolicy >

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

GetTlsInspectionPolicy(std::string const &, Options)

Gets details of a single TlsInspectionPolicy.

Parameters
Name Description
name std::string const &

Required. A name of the TlsInspectionPolicy to get. Must be in the format projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy}.

opts Options

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

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

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

GetTlsInspectionPolicy(google::cloud::networksecurity::v1::GetTlsInspectionPolicyRequest const &, Options)

Gets details of a single TlsInspectionPolicy.

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

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

CreateTlsInspectionPolicy(std::string const &, google::cloud::networksecurity::v1::TlsInspectionPolicy const &, std::string const &, Options)

Creates a new TlsInspectionPolicy in a given project and location.

Parameters
Name Description
parent std::string const &

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

tls_inspection_policy google::cloud::networksecurity::v1::TlsInspectionPolicy const &

Required. TlsInspectionPolicy resource to be created.

tls_inspection_policy_id std::string const &

Required. Short name of the TlsInspectionPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "tls_inspection_policy1".

opts Options

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

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

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

CreateTlsInspectionPolicy(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::TlsInspectionPolicy const &, std::string const &, Options)

Creates a new TlsInspectionPolicy in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
tls_inspection_policy google::cloud::networksecurity::v1::TlsInspectionPolicy const &
tls_inspection_policy_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateTlsInspectionPolicy(google::cloud::networksecurity::v1::CreateTlsInspectionPolicyRequest const &, Options)

Creates a new TlsInspectionPolicy in a given project and location.

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

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

CreateTlsInspectionPolicy(NoAwaitTag, google::cloud::networksecurity::v1::CreateTlsInspectionPolicyRequest const &, Options)

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

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

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

UpdateTlsInspectionPolicy(google::cloud::networksecurity::v1::TlsInspectionPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single TlsInspectionPolicy.

Parameters
Name Description
tls_inspection_policy google::cloud::networksecurity::v1::TlsInspectionPolicy const &

Required. Updated TlsInspectionPolicy resource.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the TlsInspectionPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

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

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

UpdateTlsInspectionPolicy(NoAwaitTag, google::cloud::networksecurity::v1::TlsInspectionPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single TlsInspectionPolicy.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
tls_inspection_policy google::cloud::networksecurity::v1::TlsInspectionPolicy const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateTlsInspectionPolicy(google::cloud::networksecurity::v1::UpdateTlsInspectionPolicyRequest const &, Options)

Updates the parameters of a single TlsInspectionPolicy.

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

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

UpdateTlsInspectionPolicy(NoAwaitTag, google::cloud::networksecurity::v1::UpdateTlsInspectionPolicyRequest const &, Options)

Updates the parameters of a single TlsInspectionPolicy.

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

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

Updates the parameters of a single TlsInspectionPolicy.

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

DeleteTlsInspectionPolicy(std::string const &, Options)

Deletes a single TlsInspectionPolicy.

Parameters
Name Description
name std::string const &

Required. A name of the TlsInspectionPolicy to delete. Must be in the format projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy}.

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.

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

Deletes a single TlsInspectionPolicy.

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 >

DeleteTlsInspectionPolicy(google::cloud::networksecurity::v1::DeleteTlsInspectionPolicyRequest const &, Options)

Deletes a single TlsInspectionPolicy.

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

DeleteTlsInspectionPolicy(NoAwaitTag, google::cloud::networksecurity::v1::DeleteTlsInspectionPolicyRequest const &, Options)

Deletes a single TlsInspectionPolicy.

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

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

Deletes a single TlsInspectionPolicy.

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

ListAuthzPolicies(std::string const &, Options)

Lists AuthzPolicies in a given project and location.

Parameters
Name Description
parent std::string const &

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

opts Options

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

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

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

ListAuthzPolicies(google::cloud::networksecurity::v1::ListAuthzPoliciesRequest, Options)

Lists AuthzPolicies in a given project and location.

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

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.ListAuthzPoliciesRequest. 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::AuthzPolicy >

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

GetAuthzPolicy(std::string const &, Options)

Gets details of a single AuthzPolicy.

Parameters
Name Description
name std::string const &

Required. A name of the AuthzPolicy resource to get. Must be in the format projects/{project}/locations/{location}/authzPolicies/{authz_policy}.

opts Options

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

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

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

GetAuthzPolicy(google::cloud::networksecurity::v1::GetAuthzPolicyRequest const &, Options)

Gets details of a single AuthzPolicy.

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

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

CreateAuthzPolicy(std::string const &, google::cloud::networksecurity::v1::AuthzPolicy const &, std::string const &, Options)

Creates a new AuthzPolicy in a given project and location.

Parameters
Name Description
parent std::string const &

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

authz_policy google::cloud::networksecurity::v1::AuthzPolicy const &

Required. AuthzPolicy resource to be created.

authz_policy_id std::string const &

Required. User-provided ID of the AuthzPolicy resource to be created.

opts Options

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

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

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

CreateAuthzPolicy(NoAwaitTag, std::string const &, google::cloud::networksecurity::v1::AuthzPolicy const &, std::string const &, Options)

Creates a new AuthzPolicy in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
authz_policy google::cloud::networksecurity::v1::AuthzPolicy const &
authz_policy_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateAuthzPolicy(google::cloud::networksecurity::v1::CreateAuthzPolicyRequest const &, Options)

Creates a new AuthzPolicy in a given project and location.

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

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

CreateAuthzPolicy(NoAwaitTag, google::cloud::networksecurity::v1::CreateAuthzPolicyRequest const &, Options)

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

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

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

UpdateAuthzPolicy(google::cloud::networksecurity::v1::AuthzPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single AuthzPolicy.

Parameters
Name Description
authz_policy google::cloud::networksecurity::v1::AuthzPolicy const &

Required. AuthzPolicy resource being updated.

update_mask google::protobuf::FieldMask const &

Required. Used to specify the fields to be overwritten in the AuthzPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.

opts Options

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

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

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

UpdateAuthzPolicy(NoAwaitTag, google::cloud::networksecurity::v1::AuthzPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single AuthzPolicy.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
authz_policy google::cloud::networksecurity::v1::AuthzPolicy const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateAuthzPolicy(google::cloud::networksecurity::v1::UpdateAuthzPolicyRequest const &, Options)

Updates the parameters of a single AuthzPolicy.

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

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

UpdateAuthzPolicy(NoAwaitTag, google::cloud::networksecurity::v1::UpdateAuthzPolicyRequest const &, Options)

Updates the parameters of a single AuthzPolicy.

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

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

Updates the parameters of a single AuthzPolicy.

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

DeleteAuthzPolicy(std::string const &, Options)

Deletes a single AuthzPolicy.

Parameters
Name Description
name std::string const &

Required. The name of the AuthzPolicy resource to delete. Must be in the format projects/{project}/locations/{location}/authzPolicies/{authz_policy}.

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.

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

Deletes a single AuthzPolicy.

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 >

DeleteAuthzPolicy(google::cloud::networksecurity::v1::DeleteAuthzPolicyRequest const &, Options)

Deletes a single AuthzPolicy.

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

DeleteAuthzPolicy(NoAwaitTag, google::cloud::networksecurity::v1::DeleteAuthzPolicyRequest const &, Options)

Deletes a single AuthzPolicy.

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

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

Deletes a single AuthzPolicy.

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.