Service for the instanceSettings resource.
https://cloud.google.com/compute/docs/reference/rest/v1/instanceSettings
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
InstanceSettingsClient(InstanceSettingsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InstanceSettingsClient const &
|
InstanceSettingsClient(InstanceSettingsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InstanceSettingsClient &&
|
InstanceSettingsClient(std::shared_ptr< InstanceSettingsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< InstanceSettingsConnection >
|
opts |
Options
|
Operators
operator=(InstanceSettingsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InstanceSettingsClient const &
|
Returns | |
---|---|
Type | Description |
InstanceSettingsClient & |
operator=(InstanceSettingsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InstanceSettingsClient &&
|
Returns | |
---|---|
Type | Description |
InstanceSettingsClient & |
Functions
GetInstanceSettings(std::string const &, std::string const &, Options)
Get Instance settings.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone 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::InstanceSettings > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InstanceSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetInstanceSettings(google::cloud::cpp::compute::instance_settings::v1::GetInstanceSettingsRequest const &, Options)
Get Instance settings.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::instance_settings::v1::GetInstanceSettingsRequest 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::InstanceSettings > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InstanceSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
PatchInstanceSettings(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceSettings const &, Options)
Patch Instance settings https://cloud.google.com/compute/docs/reference/rest/v1/instanceSettings/patch.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The zone scoping this request. It should conform to RFC1035. |
update_mask |
std::string const &
update_mask indicates fields to be updated as part of this request. |
instance_settings_resource |
google::cloud::cpp::compute::v1::InstanceSettings const &
The InstanceSettings 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 |
PatchInstanceSettings(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceSettings const &, Options)
Patch Instance settings https://cloud.google.com/compute/docs/reference/rest/v1/instanceSettings/patch.
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 &
|
update_mask |
std::string const &
|
instance_settings_resource |
google::cloud::cpp::compute::v1::InstanceSettings const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchInstanceSettings(google::cloud::cpp::compute::instance_settings::v1::PatchInstanceSettingsRequest const &, Options)
Patch Instance settings https://cloud.google.com/compute/docs/reference/rest/v1/instanceSettings/patch.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::instance_settings::v1::PatchInstanceSettingsRequest 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 |
PatchInstanceSettings(NoAwaitTag, google::cloud::cpp::compute::instance_settings::v1::PatchInstanceSettingsRequest const &, Options)
Patch Instance settings https://cloud.google.com/compute/docs/reference/rest/v1/instanceSettings/patch.
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::instance_settings::v1::PatchInstanceSettingsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchInstanceSettings(google::cloud::cpp::compute::v1::Operation const &, Options)
Patch Instance settings https://cloud.google.com/compute/docs/reference/rest/v1/instanceSettings/patch.
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 > > |