Class TargetSslProxiesClient (2.23.0-rc)

Version latest

• 2.25.0-rc (latest)
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1

Service for the targetSslProxies resource.

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

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

TargetSslProxiesClient(TargetSslProxiesClient const &)

Copy and move support

Parameter
Name	Description
	TargetSslProxiesClient const &

TargetSslProxiesClient(TargetSslProxiesClient &&)

Copy and move support

Parameter
Name	Description
	TargetSslProxiesClient &&

TargetSslProxiesClient(std::shared_ptr< TargetSslProxiesConnection >, Options)

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

Operators

operator=(TargetSslProxiesClient const &)

Copy and move support

Parameter
Name	Description
	TargetSslProxiesClient const &

Returns
Type	Description
TargetSslProxiesClient &

operator=(TargetSslProxiesClient &&)

Copy and move support

Parameter
Name	Description
	TargetSslProxiesClient &&

Returns
Type	Description
TargetSslProxiesClient &

Functions

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

Deletes the specified TargetSslProxy resource.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
target_ssl_proxy	std::string const & Name of the TargetSslProxy resource to delete.
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 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.

DeleteTargetSslProxy(google::cloud::cpp::compute::target_ssl_proxies::v1::DeleteTargetSslProxyRequest const &, Options)

Deletes the specified TargetSslProxy resource.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::target_ssl_proxies::v1::DeleteTargetSslProxyRequest 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.target_ssl_proxies.v1.DeleteTargetSslProxyRequest. 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::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.

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

Returns the specified TargetSslProxy resource.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
target_ssl_proxy	std::string const & Name of the TargetSslProxy resource to return.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetTargetSslProxy(google::cloud::cpp::compute::target_ssl_proxies::v1::GetTargetSslProxyRequest const &, Options)

Returns the specified TargetSslProxy resource.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::target_ssl_proxies::v1::GetTargetSslProxyRequest 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.target_ssl_proxies.v1.GetTargetSslProxyRequest. 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::cpp::compute::v1::TargetSslProxy >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TargetSslProxy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

InsertTargetSslProxy(std::string const &, google::cloud::cpp::compute::v1::TargetSslProxy const &, Options)

Creates a TargetSslProxy resource in the specified project using the data included in the request.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
target_ssl_proxy_resource	google::cloud::cpp::compute::v1::TargetSslProxy const & The TargetSslProxy 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 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.

InsertTargetSslProxy(google::cloud::cpp::compute::target_ssl_proxies::v1::InsertTargetSslProxyRequest const &, Options)

Creates a TargetSslProxy resource in the specified project using the data included in the request.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::target_ssl_proxies::v1::InsertTargetSslProxyRequest 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.target_ssl_proxies.v1.InsertTargetSslProxyRequest. 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::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.

ListTargetSslProxies(std::string const &, Options)

Retrieves the list of TargetSslProxy resources available to the specified project.

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

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

ListTargetSslProxies(google::cloud::cpp::compute::target_ssl_proxies::v1::ListTargetSslProxiesRequest, Options)

Retrieves the list of TargetSslProxy resources available to the specified project.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::target_ssl_proxies::v1::ListTargetSslProxiesRequest 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.target_ssl_proxies.v1.ListTargetSslProxiesRequest. 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::cpp::compute::v1::TargetSslProxy >	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.TargetSslProxy, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SetBackendService(std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetSslProxiesSetBackendServiceRequest const &, Options)

Changes the BackendService for TargetSslProxy.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
target_ssl_proxy	std::string const & Name of the TargetSslProxy resource whose BackendService resource is to be set.
target_ssl_proxies_set_backend_service_request_resource	google::cloud::cpp::compute::v1::TargetSslProxiesSetBackendServiceRequest const & The TargetSslProxiesSetBackendServiceRequest 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 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.

SetBackendService(google::cloud::cpp::compute::target_ssl_proxies::v1::SetBackendServiceRequest const &, Options)

Changes the BackendService for TargetSslProxy.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::target_ssl_proxies::v1::SetBackendServiceRequest 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.target_ssl_proxies.v1.SetBackendServiceRequest. 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::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.

SetCertificateMap(std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetSslProxiesSetCertificateMapRequest const &, Options)

Changes the Certificate Map for TargetSslProxy.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
target_ssl_proxy	std::string const & Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.
target_ssl_proxies_set_certificate_map_request_resource	google::cloud::cpp::compute::v1::TargetSslProxiesSetCertificateMapRequest const & The TargetSslProxiesSetCertificateMapRequest 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 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.

SetCertificateMap(google::cloud::cpp::compute::target_ssl_proxies::v1::SetCertificateMapRequest const &, Options)

Changes the Certificate Map for TargetSslProxy.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::target_ssl_proxies::v1::SetCertificateMapRequest 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.target_ssl_proxies.v1.SetCertificateMapRequest. 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::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.

SetProxyHeader(std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetSslProxiesSetProxyHeaderRequest const &, Options)

Changes the ProxyHeaderType for TargetSslProxy.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
target_ssl_proxy	std::string const & Name of the TargetSslProxy resource whose ProxyHeader is to be set.
target_ssl_proxies_set_proxy_header_request_resource	google::cloud::cpp::compute::v1::TargetSslProxiesSetProxyHeaderRequest const & The TargetSslProxiesSetProxyHeaderRequest 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 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.

SetProxyHeader(google::cloud::cpp::compute::target_ssl_proxies::v1::SetProxyHeaderRequest const &, Options)

Changes the ProxyHeaderType for TargetSslProxy.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::target_ssl_proxies::v1::SetProxyHeaderRequest 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.target_ssl_proxies.v1.SetProxyHeaderRequest. 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::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.

SetSslCertificates(std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetSslProxiesSetSslCertificatesRequest const &, Options)

Changes SslCertificates for TargetSslProxy.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
target_ssl_proxy	std::string const & Name of the TargetSslProxy resource whose SslCertificate resource is to be set.
target_ssl_proxies_set_ssl_certificates_request_resource	google::cloud::cpp::compute::v1::TargetSslProxiesSetSslCertificatesRequest const & The TargetSslProxiesSetSslCertificatesRequest 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 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.

SetSslCertificates(google::cloud::cpp::compute::target_ssl_proxies::v1::SetSslCertificatesRequest const &, Options)

Changes SslCertificates for TargetSslProxy.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::target_ssl_proxies::v1::SetSslCertificatesRequest 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.target_ssl_proxies.v1.SetSslCertificatesRequest. 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::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.

SetSslPolicy(std::string const &, std::string const &, google::cloud::cpp::compute::v1::SslPolicyReference const &, Options)

Sets the SSL policy for TargetSslProxy.

The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the load balancer. They do not affect the connection between the load balancer and the backends. https://cloud.google.com/compute/docs/reference/rest/v1/targetSslProxies/setSslPolicy

Parameters
Name	Description
project	std::string const & Project ID for this request.
target_ssl_proxy	std::string const & Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.
ssl_policy_reference_resource	google::cloud::cpp::compute::v1::SslPolicyReference const & The SslPolicyReference 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 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.

SetSslPolicy(google::cloud::cpp::compute::target_ssl_proxies::v1::SetSslPolicyRequest const &, Options)

Sets the SSL policy for TargetSslProxy.

The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the load balancer. They do not affect the connection between the load balancer and the backends. https://cloud.google.com/compute/docs/reference/rest/v1/targetSslProxies/setSslPolicy

Parameters
Name	Description
request	google::cloud::cpp::compute::target_ssl_proxies::v1::SetSslPolicyRequest 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.target_ssl_proxies.v1.SetSslPolicyRequest. 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::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.