Class NetworkSecurityClient (2.18.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
NameDescription
NetworkSecurityClient const &

NetworkSecurityClient(NetworkSecurityClient &&)

Copy and move support

Parameter
NameDescription
NetworkSecurityClient &&

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

Parameters
NameDescription
connection std::shared_ptr< NetworkSecurityConnection >
opts Options

Operators

operator=(NetworkSecurityClient const &)

Copy and move support

Parameter
NameDescription
NetworkSecurityClient const &
Returns
TypeDescription
NetworkSecurityClient &

operator=(NetworkSecurityClient &&)

Copy and move support

Parameter
NameDescription
NetworkSecurityClient &&
Returns
TypeDescription
NetworkSecurityClient &

Functions

ListAuthorizationPolicies(std::string const &, Options)

Lists AuthorizationPolicies in a given project and location.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::CreateAuthorizationPolicyRequest const &, Options)

Creates a new AuthorizationPolicy in a given project and location.

Parameters
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::AuthorizationPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single AuthorizationPolicy.

Parameters
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::UpdateAuthorizationPolicyRequest const &, Options)

Updates the parameters of a single AuthorizationPolicy.

Parameters
NameDescription
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
TypeDescription
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.

DeleteAuthorizationPolicy(std::string const &, Options)

Deletes a single AuthorizationPolicy.

Parameters
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::DeleteAuthorizationPolicyRequest const &, Options)

Deletes a single AuthorizationPolicy.

Parameters
NameDescription
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
TypeDescription
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.

ListServerTlsPolicies(std::string const &, Options)

Lists ServerTlsPolicies in a given project and location.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::CreateServerTlsPolicyRequest const &, Options)

Creates a new ServerTlsPolicy in a given project and location.

Parameters
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::ServerTlsPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ServerTlsPolicy.

Parameters
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::UpdateServerTlsPolicyRequest const &, Options)

Updates the parameters of a single ServerTlsPolicy.

Parameters
NameDescription
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
TypeDescription
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.

DeleteServerTlsPolicy(std::string const &, Options)

Deletes a single ServerTlsPolicy.

Parameters
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::DeleteServerTlsPolicyRequest const &, Options)

Deletes a single ServerTlsPolicy.

Parameters
NameDescription
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
TypeDescription
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.

ListClientTlsPolicies(std::string const &, Options)

Lists ClientTlsPolicies in a given project and location.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::CreateClientTlsPolicyRequest const &, Options)

Creates a new ClientTlsPolicy in a given project and location.

Parameters
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::ClientTlsPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ClientTlsPolicy.

Parameters
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::UpdateClientTlsPolicyRequest const &, Options)

Updates the parameters of a single ClientTlsPolicy.

Parameters
NameDescription
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
TypeDescription
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.

DeleteClientTlsPolicy(std::string const &, Options)

Deletes a single ClientTlsPolicy.

Parameters
NameDescription
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
TypeDescription
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(google::cloud::networksecurity::v1::DeleteClientTlsPolicyRequest const &, Options)

Deletes a single ClientTlsPolicy.

Parameters
NameDescription
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
TypeDescription
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.