Service for the targetTcpProxies resource.
https://cloud.google.com/compute/docs/reference/rest/v1/targetTcpProxies
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
TargetTcpProxiesClient(TargetTcpProxiesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TargetTcpProxiesClient const &
|
TargetTcpProxiesClient(TargetTcpProxiesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TargetTcpProxiesClient &&
|
TargetTcpProxiesClient(std::shared_ptr< TargetTcpProxiesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< TargetTcpProxiesConnection >
|
opts |
Options
|
Operators
operator=(TargetTcpProxiesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TargetTcpProxiesClient const &
|
Returns | |
---|---|
Type | Description |
TargetTcpProxiesClient & |
operator=(TargetTcpProxiesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TargetTcpProxiesClient &&
|
Returns | |
---|---|
Type | Description |
TargetTcpProxiesClient & |
Functions
AggregatedListTargetTcpProxies(std::string const &, Options)
Retrieves the list of all TargetTcpProxy 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/targetTcpProxies/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::TargetTcpProxiesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListTargetTcpProxies(google::cloud::cpp::compute::target_tcp_proxies::v1::AggregatedListTargetTcpProxiesRequest, Options)
Retrieves the list of all TargetTcpProxy 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/targetTcpProxies/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_tcp_proxies::v1::AggregatedListTargetTcpProxiesRequest
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::TargetTcpProxiesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteTargetTcpProxy(std::string const &, std::string const &, Options)
Deletes the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
target_tcp_proxy |
std::string const &
Name of the TargetTcpProxy 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 |
DeleteTargetTcpProxy(NoAwaitTag, std::string const &, std::string const &, Options)
Deletes the specified TargetTcpProxy 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 &
|
target_tcp_proxy |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteTargetTcpProxy(google::cloud::cpp::compute::target_tcp_proxies::v1::DeleteTargetTcpProxyRequest const &, Options)
Deletes the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_tcp_proxies::v1::DeleteTargetTcpProxyRequest 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 |
DeleteTargetTcpProxy(NoAwaitTag, google::cloud::cpp::compute::target_tcp_proxies::v1::DeleteTargetTcpProxyRequest const &, Options)
Deletes the specified TargetTcpProxy 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::target_tcp_proxies::v1::DeleteTargetTcpProxyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteTargetTcpProxy(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified TargetTcpProxy 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 > > |
GetTargetTcpProxy(std::string const &, std::string const &, Options)
Returns the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
target_tcp_proxy |
std::string const &
Name of the TargetTcpProxy 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::TargetTcpProxy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TargetTcpProxy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTargetTcpProxy(google::cloud::cpp::compute::target_tcp_proxies::v1::GetTargetTcpProxyRequest const &, Options)
Returns the specified TargetTcpProxy resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_tcp_proxies::v1::GetTargetTcpProxyRequest 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::TargetTcpProxy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TargetTcpProxy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertTargetTcpProxy(std::string const &, google::cloud::cpp::compute::v1::TargetTcpProxy const &, Options)
Creates a TargetTcpProxy resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
target_tcp_proxy_resource |
google::cloud::cpp::compute::v1::TargetTcpProxy const &
The TargetTcpProxy 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 |
InsertTargetTcpProxy(NoAwaitTag, std::string const &, google::cloud::cpp::compute::v1::TargetTcpProxy const &, Options)
Creates a TargetTcpProxy resource in the specified project using 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 &
|
target_tcp_proxy_resource |
google::cloud::cpp::compute::v1::TargetTcpProxy const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertTargetTcpProxy(google::cloud::cpp::compute::target_tcp_proxies::v1::InsertTargetTcpProxyRequest const &, Options)
Creates a TargetTcpProxy resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_tcp_proxies::v1::InsertTargetTcpProxyRequest 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 |
InsertTargetTcpProxy(NoAwaitTag, google::cloud::cpp::compute::target_tcp_proxies::v1::InsertTargetTcpProxyRequest const &, Options)
Creates a TargetTcpProxy resource in the specified project using 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::target_tcp_proxies::v1::InsertTargetTcpProxyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertTargetTcpProxy(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a TargetTcpProxy resource in the specified project using 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 > > |
ListTargetTcpProxies(std::string const &, Options)
Retrieves the list of TargetTcpProxy resources available to 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::TargetTcpProxy > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTargetTcpProxies(google::cloud::cpp::compute::target_tcp_proxies::v1::ListTargetTcpProxiesRequest, Options)
Retrieves the list of TargetTcpProxy resources available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_tcp_proxies::v1::ListTargetTcpProxiesRequest
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::TargetTcpProxy > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SetBackendService(std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetTcpProxiesSetBackendServiceRequest const &, Options)
Changes the BackendService for TargetTcpProxy.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
target_tcp_proxy |
std::string const &
Name of the TargetTcpProxy resource whose BackendService resource is to be set. |
target_tcp_proxies_set_backend_service_request_resource |
google::cloud::cpp::compute::v1::TargetTcpProxiesSetBackendServiceRequest const &
The TargetTcpProxiesSetBackendServiceRequest 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 |
SetBackendService(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetTcpProxiesSetBackendServiceRequest const &, Options)
Changes the BackendService for TargetTcpProxy.
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 &
|
target_tcp_proxy |
std::string const &
|
target_tcp_proxies_set_backend_service_request_resource |
google::cloud::cpp::compute::v1::TargetTcpProxiesSetBackendServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetBackendService(google::cloud::cpp::compute::target_tcp_proxies::v1::SetBackendServiceRequest const &, Options)
Changes the BackendService for TargetTcpProxy.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_tcp_proxies::v1::SetBackendServiceRequest 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 |
SetBackendService(NoAwaitTag, google::cloud::cpp::compute::target_tcp_proxies::v1::SetBackendServiceRequest const &, Options)
Changes the BackendService for TargetTcpProxy.
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::target_tcp_proxies::v1::SetBackendServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetBackendService(google::cloud::cpp::compute::v1::Operation const &, Options)
Changes the BackendService for TargetTcpProxy.
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 > > |
SetProxyHeader(std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetTcpProxiesSetProxyHeaderRequest const &, Options)
Changes the ProxyHeaderType for TargetTcpProxy.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
target_tcp_proxy |
std::string const &
Name of the TargetTcpProxy resource whose ProxyHeader is to be set. |
target_tcp_proxies_set_proxy_header_request_resource |
google::cloud::cpp::compute::v1::TargetTcpProxiesSetProxyHeaderRequest const &
The TargetTcpProxiesSetProxyHeaderRequest 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 |
SetProxyHeader(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetTcpProxiesSetProxyHeaderRequest const &, Options)
Changes the ProxyHeaderType for TargetTcpProxy.
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 &
|
target_tcp_proxy |
std::string const &
|
target_tcp_proxies_set_proxy_header_request_resource |
google::cloud::cpp::compute::v1::TargetTcpProxiesSetProxyHeaderRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetProxyHeader(google::cloud::cpp::compute::target_tcp_proxies::v1::SetProxyHeaderRequest const &, Options)
Changes the ProxyHeaderType for TargetTcpProxy.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_tcp_proxies::v1::SetProxyHeaderRequest 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 |
SetProxyHeader(NoAwaitTag, google::cloud::cpp::compute::target_tcp_proxies::v1::SetProxyHeaderRequest const &, Options)
Changes the ProxyHeaderType for TargetTcpProxy.
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::target_tcp_proxies::v1::SetProxyHeaderRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetProxyHeader(google::cloud::cpp::compute::v1::Operation const &, Options)
Changes the ProxyHeaderType for TargetTcpProxy.
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 > > |