Service for the autoscalers resource.
https://cloud.google.com/compute/docs/reference/rest/v1/autoscalers
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
AutoscalersClient(AutoscalersClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AutoscalersClient const &
|
AutoscalersClient(AutoscalersClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AutoscalersClient &&
|
AutoscalersClient(std::shared_ptr< AutoscalersConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< AutoscalersConnection >
|
opts |
Options
|
Operators
operator=(AutoscalersClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AutoscalersClient const &
|
Returns | |
---|---|
Type | Description |
AutoscalersClient & |
operator=(AutoscalersClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AutoscalersClient &&
|
Returns | |
---|---|
Type | Description |
AutoscalersClient & |
Functions
AggregatedListAutoscalers(std::string const &, Options)
Retrieves an aggregated list of autoscalers.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/autoscalers/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::AutoscalersScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListAutoscalers(google::cloud::cpp::compute::autoscalers::v1::AggregatedListAutoscalersRequest, Options)
Retrieves an aggregated list of autoscalers.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/autoscalers/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::autoscalers::v1::AggregatedListAutoscalersRequest
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::AutoscalersScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteAutoscaler(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified autoscaler.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
autoscaler |
std::string const &
Name of the autoscaler 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 |
DeleteAutoscaler(ExperimentalTag, NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified autoscaler.
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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
project |
std::string const &
|
zone |
std::string const &
|
autoscaler |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteAutoscaler(google::cloud::cpp::compute::autoscalers::v1::DeleteAutoscalerRequest const &, Options)
Deletes the specified autoscaler.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::autoscalers::v1::DeleteAutoscalerRequest 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 |
DeleteAutoscaler(ExperimentalTag, NoAwaitTag, google::cloud::cpp::compute::autoscalers::v1::DeleteAutoscalerRequest const &, Options)
Deletes the specified autoscaler.
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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::autoscalers::v1::DeleteAutoscalerRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteAutoscaler(ExperimentalTag, google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified autoscaler.
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 |
|
ExperimentalTag
|
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
GetAutoscaler(std::string const &, std::string const &, std::string const &, Options)
Returns the specified autoscaler resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
autoscaler |
std::string const &
Name of the autoscaler 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::Autoscaler > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Autoscaler) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAutoscaler(google::cloud::cpp::compute::autoscalers::v1::GetAutoscalerRequest const &, Options)
Returns the specified autoscaler resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::autoscalers::v1::GetAutoscalerRequest 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::Autoscaler > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Autoscaler) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertAutoscaler(std::string const &, std::string const &, google::cloud::cpp::compute::v1::Autoscaler const &, Options)
Creates an autoscaler in the specified project 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 for this request. |
autoscaler_resource |
google::cloud::cpp::compute::v1::Autoscaler const &
The Autoscaler 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 |
InsertAutoscaler(ExperimentalTag, NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Autoscaler const &, Options)
Creates an autoscaler 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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
project |
std::string const &
|
zone |
std::string const &
|
autoscaler_resource |
google::cloud::cpp::compute::v1::Autoscaler const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertAutoscaler(google::cloud::cpp::compute::autoscalers::v1::InsertAutoscalerRequest const &, Options)
Creates an autoscaler in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::autoscalers::v1::InsertAutoscalerRequest 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 |
InsertAutoscaler(ExperimentalTag, NoAwaitTag, google::cloud::cpp::compute::autoscalers::v1::InsertAutoscalerRequest const &, Options)
Creates an autoscaler 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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::autoscalers::v1::InsertAutoscalerRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertAutoscaler(ExperimentalTag, google::cloud::cpp::compute::v1::Operation const &, Options)
Creates an autoscaler 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 |
|
ExperimentalTag
|
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
ListAutoscalers(std::string const &, std::string const &, Options)
Retrieves a list of autoscalers contained within the specified zone.
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 |
StreamRange< google::cloud::cpp::compute::v1::Autoscaler > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAutoscalers(google::cloud::cpp::compute::autoscalers::v1::ListAutoscalersRequest, Options)
Retrieves a list of autoscalers contained within the specified zone.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::autoscalers::v1::ListAutoscalersRequest
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::Autoscaler > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchAutoscaler(std::string const &, std::string const &, google::cloud::cpp::compute::v1::Autoscaler const &, Options)
Updates an autoscaler in the specified project using the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/autoscalers/patch
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
autoscaler_resource |
google::cloud::cpp::compute::v1::Autoscaler const &
The Autoscaler 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 |
PatchAutoscaler(ExperimentalTag, NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Autoscaler const &, Options)
Updates an autoscaler 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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
project |
std::string const &
|
zone |
std::string const &
|
autoscaler_resource |
google::cloud::cpp::compute::v1::Autoscaler const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchAutoscaler(google::cloud::cpp::compute::autoscalers::v1::PatchAutoscalerRequest const &, Options)
Updates an autoscaler in the specified project using the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/autoscalers/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::autoscalers::v1::PatchAutoscalerRequest 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 |
PatchAutoscaler(ExperimentalTag, NoAwaitTag, google::cloud::cpp::compute::autoscalers::v1::PatchAutoscalerRequest const &, Options)
Updates an autoscaler 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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::autoscalers::v1::PatchAutoscalerRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchAutoscaler(ExperimentalTag, google::cloud::cpp::compute::v1::Operation const &, Options)
Updates an autoscaler 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 |
|
ExperimentalTag
|
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
UpdateAutoscaler(std::string const &, std::string const &, google::cloud::cpp::compute::v1::Autoscaler const &, Options)
Updates an autoscaler in the specified project 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 for this request. |
autoscaler_resource |
google::cloud::cpp::compute::v1::Autoscaler const &
The Autoscaler 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 |
UpdateAutoscaler(ExperimentalTag, NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Autoscaler const &, Options)
Updates an autoscaler 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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
project |
std::string const &
|
zone |
std::string const &
|
autoscaler_resource |
google::cloud::cpp::compute::v1::Autoscaler const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateAutoscaler(google::cloud::cpp::compute::autoscalers::v1::UpdateAutoscalerRequest const &, Options)
Updates an autoscaler in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::autoscalers::v1::UpdateAutoscalerRequest 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 |
UpdateAutoscaler(ExperimentalTag, NoAwaitTag, google::cloud::cpp::compute::autoscalers::v1::UpdateAutoscalerRequest const &, Options)
Updates an autoscaler 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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::autoscalers::v1::UpdateAutoscalerRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateAutoscaler(ExperimentalTag, google::cloud::cpp::compute::v1::Operation const &, Options)
Updates an autoscaler 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 |
|
ExperimentalTag
|
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |