Class AutoscalersClient (2.17.0)

Version 2.17.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 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 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.

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

AggregatedListAutoscalers(google::cloud::cpp::compute::autoscalers::v1::AggregatedListAutoscalersRequest, Options)

Retrieves an aggregated list of autoscalers.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.autoscalers.v1.AggregatedListAutoscalersRequest. 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< 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 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.AutoscalersScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

Deletes the specified autoscaler.

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

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 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.

DeleteAutoscaler(google::cloud::cpp::compute::autoscalers::v1::DeleteAutoscalerRequest const &, Options)

Deletes the specified autoscaler.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.autoscalers.v1.DeleteAutoscalerRequest. 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.

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

Returns the specified autoscaler resource.

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

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 StatusOr contains the error details.

GetAutoscaler(google::cloud::cpp::compute::autoscalers::v1::GetAutoscalerRequest const &, Options)

Returns the specified autoscaler resource.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.autoscalers.v1.GetAutoscalerRequest. 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::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 StatusOr contains the error details.

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.

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

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 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.

InsertAutoscaler(google::cloud::cpp::compute::autoscalers::v1::InsertAutoscalerRequest const &, Options)

Creates an autoscaler in the specified project using the data included in the request.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.autoscalers.v1.InsertAutoscalerRequest. 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.

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

Retrieves a list of autoscalers contained within the specified zone.

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

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

ListAutoscalers(google::cloud::cpp::compute::autoscalers::v1::ListAutoscalersRequest, Options)

Retrieves a list of autoscalers contained within the specified zone.

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

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

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 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.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.autoscalers.v1.PatchAutoscalerRequest. 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.

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.

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

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 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.

UpdateAutoscaler(google::cloud::cpp::compute::autoscalers::v1::UpdateAutoscalerRequest const &, Options)

Updates an autoscaler in the specified project using the data included in the request.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.autoscalers.v1.UpdateAutoscalerRequest. 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.