Class SslPoliciesClient (2.23.0-rc)

Service for the sslPolicies resource.

https://cloud.google.com/compute/docs/reference/rest/v1/sslPolicies

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

SslPoliciesClient(SslPoliciesClient const &)

Copy and move support

Parameter
NameDescription
SslPoliciesClient const &

SslPoliciesClient(SslPoliciesClient &&)

Copy and move support

Parameter
NameDescription
SslPoliciesClient &&

SslPoliciesClient(std::shared_ptr< SslPoliciesConnection >, Options)

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

Operators

operator=(SslPoliciesClient const &)

Copy and move support

Parameter
NameDescription
SslPoliciesClient const &
Returns
TypeDescription
SslPoliciesClient &

operator=(SslPoliciesClient &&)

Copy and move support

Parameter
NameDescription
SslPoliciesClient &&
Returns
TypeDescription
SslPoliciesClient &

Functions

AggregatedListSslPolicies(std::string const &, Options)

Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. https://cloud.google.com/compute/docs/reference/rest/v1/sslPolicies/aggregatedList

Parameters
NameDescription
project std::string const &

Name of the project scoping this request.

opts Options

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

Returns
TypeDescription
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::SslPoliciesScopedList > >

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

AggregatedListSslPolicies(google::cloud::cpp::compute::ssl_policies::v1::AggregatedListSslPoliciesRequest, Options)

Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. https://cloud.google.com/compute/docs/reference/rest/v1/sslPolicies/aggregatedList

Parameters
NameDescription
request google::cloud::cpp::compute::ssl_policies::v1::AggregatedListSslPoliciesRequest

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.cpp.compute.ssl_policies.v1.AggregatedListSslPoliciesRequest. 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< std::pair< std::string, google::cloud::cpp::compute::v1::SslPoliciesScopedList > >

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

DeleteSslPolicy(std::string const &, std::string const &, Options)

Deletes the specified SSL policy.

The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. https://cloud.google.com/compute/docs/reference/rest/v1/sslPolicies/delete

Parameters
NameDescription
project std::string const &

Project ID for this request.

ssl_policy std::string const &

Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

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

DeleteSslPolicy(google::cloud::cpp::compute::ssl_policies::v1::DeleteSslPolicyRequest const &, Options)

Deletes the specified SSL policy.

The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. https://cloud.google.com/compute/docs/reference/rest/v1/sslPolicies/delete

Parameters
NameDescription
request google::cloud::cpp::compute::ssl_policies::v1::DeleteSslPolicyRequest 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.cpp.compute.ssl_policies.v1.DeleteSslPolicyRequest. 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::cpp::compute::v1::Operation > >

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

GetSslPolicy(std::string const &, std::string const &, Options)

Lists all of the ordered rules present in a single specified policy.

Parameters
NameDescription
project std::string const &

Project ID for this request.

ssl_policy std::string const &

Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.

opts Options

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

Returns
TypeDescription
StatusOr< google::cloud::cpp::compute::v1::SslPolicy >

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

GetSslPolicy(google::cloud::cpp::compute::ssl_policies::v1::GetSslPolicyRequest const &, Options)

Lists all of the ordered rules present in a single specified policy.

Parameters
NameDescription
request google::cloud::cpp::compute::ssl_policies::v1::GetSslPolicyRequest 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.cpp.compute.ssl_policies.v1.GetSslPolicyRequest. 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::cpp::compute::v1::SslPolicy >

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

InsertSslPolicy(std::string const &, google::cloud::cpp::compute::v1::SslPolicy const &, Options)

Returns the specified SSL policy resource.

Parameters
NameDescription
project std::string const &

Project ID for this request.

ssl_policy_resource google::cloud::cpp::compute::v1::SslPolicy const &

The SslPolicy for this request.

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

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

InsertSslPolicy(google::cloud::cpp::compute::ssl_policies::v1::InsertSslPolicyRequest const &, Options)

Returns the specified SSL policy resource.

Parameters
NameDescription
request google::cloud::cpp::compute::ssl_policies::v1::InsertSslPolicyRequest 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.cpp.compute.ssl_policies.v1.InsertSslPolicyRequest. 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::cpp::compute::v1::Operation > >

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

ListSslPolicies(std::string const &, Options)

Lists all the SSL policies that have been configured for the specified project.

Parameters
NameDescription
project std::string const &

Project ID for this request.

opts Options

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

Returns
TypeDescription
StreamRange< google::cloud::cpp::compute::v1::SslPolicy >

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

ListSslPolicies(google::cloud::cpp::compute::ssl_policies::v1::ListSslPoliciesRequest, Options)

Lists all the SSL policies that have been configured for the specified project.

Parameters
NameDescription
request google::cloud::cpp::compute::ssl_policies::v1::ListSslPoliciesRequest

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.cpp.compute.ssl_policies.v1.ListSslPoliciesRequest. 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::cpp::compute::v1::SslPolicy >

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

ListAvailableFeatures(std::string const &, Options)

Lists all features that can be specified in the SSL policy when using custom profile.

Parameters
NameDescription
project std::string const &

Project ID for this request.

opts Options

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

Returns
TypeDescription
StatusOr< google::cloud::cpp::compute::v1::SslPoliciesListAvailableFeaturesResponse >

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

ListAvailableFeatures(google::cloud::cpp::compute::ssl_policies::v1::ListAvailableFeaturesRequest const &, Options)

Lists all features that can be specified in the SSL policy when using custom profile.

Parameters
NameDescription
request google::cloud::cpp::compute::ssl_policies::v1::ListAvailableFeaturesRequest 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.cpp.compute.ssl_policies.v1.ListAvailableFeaturesRequest. 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::cpp::compute::v1::SslPoliciesListAvailableFeaturesResponse >

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

PatchSslPolicy(std::string const &, std::string const &, google::cloud::cpp::compute::v1::SslPolicy const &, Options)

Patches the specified SSL policy with the data included in the request.

Parameters
NameDescription
project std::string const &

Project ID for this request.

ssl_policy std::string const &

Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.

ssl_policy_resource google::cloud::cpp::compute::v1::SslPolicy const &

The SslPolicy for this request.

opts Options

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

Returns
TypeDescription
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >

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

PatchSslPolicy(google::cloud::cpp::compute::ssl_policies::v1::PatchSslPolicyRequest const &, Options)

Patches the specified SSL policy with the data included in the request.

Parameters
NameDescription
request google::cloud::cpp::compute::ssl_policies::v1::PatchSslPolicyRequest 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.cpp.compute.ssl_policies.v1.PatchSslPolicyRequest. 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::cpp::compute::v1::Operation > >

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