Service for the targetInstances resource.
https://cloud.google.com/compute/docs/reference/rest/v1/targetInstances
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
TargetInstancesClient(TargetInstancesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TargetInstancesClient const &
|
TargetInstancesClient(TargetInstancesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TargetInstancesClient &&
|
TargetInstancesClient(std::shared_ptr< TargetInstancesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< TargetInstancesConnection >
|
opts |
Options
|
Operators
operator=(TargetInstancesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TargetInstancesClient const &
|
Returns | |
---|---|
Type | Description |
TargetInstancesClient & |
operator=(TargetInstancesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TargetInstancesClient &&
|
Returns | |
---|---|
Type | Description |
TargetInstancesClient & |
Functions
AggregatedListTargetInstances(std::string const &, Options)
Retrieves an aggregated list of target instances.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/targetInstances/aggregatedList
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< std::pair< std::string, google::cloud::cpp::compute::v1::TargetInstancesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListTargetInstances(google::cloud::cpp::compute::target_instances::v1::AggregatedListTargetInstancesRequest, Options)
Retrieves an aggregated list of target instances.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/targetInstances/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_instances::v1::AggregatedListTargetInstancesRequest
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::TargetInstancesScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteTargetInstance(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified TargetInstance resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone scoping this request. |
target_instance |
std::string const &
Name of the TargetInstance 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 |
DeleteTargetInstance(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified TargetInstance 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 &
|
zone |
std::string const &
|
target_instance |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteTargetInstance(google::cloud::cpp::compute::target_instances::v1::DeleteTargetInstanceRequest const &, Options)
Deletes the specified TargetInstance resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_instances::v1::DeleteTargetInstanceRequest 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 |
DeleteTargetInstance(NoAwaitTag, google::cloud::cpp::compute::target_instances::v1::DeleteTargetInstanceRequest const &, Options)
Deletes the specified TargetInstance 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_instances::v1::DeleteTargetInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteTargetInstance(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified TargetInstance 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 > > |
GetTargetInstance(std::string const &, std::string const &, std::string const &, Options)
Returns the specified TargetInstance resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone scoping this request. |
target_instance |
std::string const &
Name of the TargetInstance 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::TargetInstance > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TargetInstance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTargetInstance(google::cloud::cpp::compute::target_instances::v1::GetTargetInstanceRequest const &, Options)
Returns the specified TargetInstance resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_instances::v1::GetTargetInstanceRequest 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::TargetInstance > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TargetInstance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertTargetInstance(std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetInstance const &, Options)
Creates a TargetInstance resource in the specified project and zone using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone scoping this request. |
target_instance_resource |
google::cloud::cpp::compute::v1::TargetInstance const &
The TargetInstance 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 |
InsertTargetInstance(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TargetInstance const &, Options)
Creates a TargetInstance resource in the specified project and zone 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 &
|
zone |
std::string const &
|
target_instance_resource |
google::cloud::cpp::compute::v1::TargetInstance const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertTargetInstance(google::cloud::cpp::compute::target_instances::v1::InsertTargetInstanceRequest const &, Options)
Creates a TargetInstance resource in the specified project and zone using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_instances::v1::InsertTargetInstanceRequest 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 |
InsertTargetInstance(NoAwaitTag, google::cloud::cpp::compute::target_instances::v1::InsertTargetInstanceRequest const &, Options)
Creates a TargetInstance resource in the specified project and zone 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_instances::v1::InsertTargetInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertTargetInstance(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a TargetInstance resource in the specified project and zone 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 > > |
ListTargetInstances(std::string const &, std::string const &, Options)
Retrieves a list of TargetInstance resources available to the specified project and zone.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone scoping 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::TargetInstance > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTargetInstances(google::cloud::cpp::compute::target_instances::v1::ListTargetInstancesRequest, Options)
Retrieves a list of TargetInstance resources available to the specified project and zone.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_instances::v1::ListTargetInstancesRequest
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::TargetInstance > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SetSecurityPolicy(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::SecurityPolicyReference const &, Options)
Sets the Google Cloud Armor security policy for the specified target instance.
For more information, see Google Cloud Armor Overview https://cloud.google.com/compute/docs/reference/rest/v1/targetInstances/setSecurityPolicy
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone scoping this request. |
target_instance |
std::string const &
Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035. |
security_policy_reference_resource |
google::cloud::cpp::compute::v1::SecurityPolicyReference const &
The SecurityPolicyReference 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 |
SetSecurityPolicy(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::SecurityPolicyReference const &, Options)
Sets the Google Cloud Armor security policy for the specified target instance.
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 &
|
zone |
std::string const &
|
target_instance |
std::string const &
|
security_policy_reference_resource |
google::cloud::cpp::compute::v1::SecurityPolicyReference const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetSecurityPolicy(google::cloud::cpp::compute::target_instances::v1::SetSecurityPolicyRequest const &, Options)
Sets the Google Cloud Armor security policy for the specified target instance.
For more information, see Google Cloud Armor Overview https://cloud.google.com/compute/docs/reference/rest/v1/targetInstances/setSecurityPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::target_instances::v1::SetSecurityPolicyRequest 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 |
SetSecurityPolicy(NoAwaitTag, google::cloud::cpp::compute::target_instances::v1::SetSecurityPolicyRequest const &, Options)
Sets the Google Cloud Armor security policy for the specified target instance.
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_instances::v1::SetSecurityPolicyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetSecurityPolicy(google::cloud::cpp::compute::v1::Operation const &, Options)
Sets the Google Cloud Armor security policy for the specified target instance.
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 > > |