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 | |
---|---|
Name | Description |
|
SslPoliciesClient const &
|
SslPoliciesClient(SslPoliciesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SslPoliciesClient &&
|
SslPoliciesClient(std::shared_ptr< SslPoliciesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< SslPoliciesConnection >
|
opts |
Options
|
Operators
operator=(SslPoliciesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SslPoliciesClient const &
|
Returns | |
---|---|
Type | Description |
SslPoliciesClient & |
operator=(SslPoliciesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SslPoliciesClient &&
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
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 | |
---|---|
Type | Description |
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 |
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 | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::ssl_policies::v1::AggregatedListSslPoliciesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
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 | |
---|---|
Name | Description |
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 | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
DeleteSslPolicy(NoAwaitTag, std::string const &, std::string const &, Options)
Deletes the specified SSL policy.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
ssl_policy |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
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 | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::ssl_policies::v1::DeleteSslPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
DeleteSslPolicy(NoAwaitTag, google::cloud::cpp::compute::ssl_policies::v1::DeleteSslPolicyRequest const &, Options)
Deletes the specified SSL policy.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::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::cpp::compute::ssl_policies::v1::DeleteSslPolicyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteSslPolicy(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified SSL policy.
This method accepts a google::cloud::cpp::compute::v1::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::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
GetSslPolicy(std::string const &, std::string const &, Options)
Lists all of the ordered rules present in a single specified policy.
Parameters | |
---|---|
Name | Description |
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 | |
---|---|
Type | Description |
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 |
GetSslPolicy(google::cloud::cpp::compute::ssl_policies::v1::GetSslPolicyRequest const &, Options)
Lists all of the ordered rules present in a single specified policy.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::ssl_policies::v1::GetSslPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
InsertSslPolicy(std::string const &, google::cloud::cpp::compute::v1::SslPolicy const &, Options)
Returns the specified SSL policy resource.
Parameters | |
---|---|
Name | Description |
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 | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InsertSslPolicy(NoAwaitTag, std::string const &, google::cloud::cpp::compute::v1::SslPolicy const &, Options)
Returns the specified SSL policy resource.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
ssl_policy_resource |
google::cloud::cpp::compute::v1::SslPolicy const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertSslPolicy(google::cloud::cpp::compute::ssl_policies::v1::InsertSslPolicyRequest const &, Options)
Returns the specified SSL policy resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::ssl_policies::v1::InsertSslPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InsertSslPolicy(NoAwaitTag, google::cloud::cpp::compute::ssl_policies::v1::InsertSslPolicyRequest const &, Options)
Returns the specified SSL policy resource.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::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::cpp::compute::ssl_policies::v1::InsertSslPolicyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertSslPolicy(google::cloud::cpp::compute::v1::Operation const &, Options)
Returns the specified SSL policy resource.
This method accepts a google::cloud::cpp::compute::v1::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::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
ListSslPolicies(std::string const &, Options)
Lists all the SSL policies that have been configured for the specified project.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
ListSslPolicies(google::cloud::cpp::compute::ssl_policies::v1::ListSslPoliciesRequest, Options)
Lists all the SSL policies that have been configured for the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::ssl_policies::v1::ListSslPoliciesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
ListAvailableFeatures(std::string const &, Options)
Lists all features that can be specified in the SSL policy when using custom profile.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
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 | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::ssl_policies::v1::ListAvailableFeaturesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
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 | |
---|---|
Name | Description |
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 | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
PatchSslPolicy(NoAwaitTag, 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.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
ssl_policy |
std::string const &
|
ssl_policy_resource |
google::cloud::cpp::compute::v1::SslPolicy const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchSslPolicy(google::cloud::cpp::compute::ssl_policies::v1::PatchSslPolicyRequest const &, Options)
Patches the specified SSL policy with the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::ssl_policies::v1::PatchSslPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
PatchSslPolicy(NoAwaitTag, google::cloud::cpp::compute::ssl_policies::v1::PatchSslPolicyRequest const &, Options)
Patches the specified SSL policy with the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::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::cpp::compute::ssl_policies::v1::PatchSslPolicyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchSslPolicy(google::cloud::cpp::compute::v1::Operation const &, Options)
Patches the specified SSL policy with the data included in the request.
This method accepts a google::cloud::cpp::compute::v1::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::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |