Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class AdviceClient (3.12.0-rc)

Service for the advice resource.

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

This client uses Advice version 2026-09-01.

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

AdviceClient(AdviceClient const &)

Copy and move support

Parameter
Name	Description
	`AdviceClient const &`

AdviceClient(AdviceClient &&)

Copy and move support

Parameter
Name	Description
	`AdviceClient &&`

AdviceClient(std::shared_ptr< AdviceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< AdviceConnection >`
`opts`	`Options`

Operators

operator=(AdviceClient const &)

Copy and move support

Parameter
Name	Description
	`AdviceClient const &`

Returns
Type	Description
`AdviceClient &`

operator=(AdviceClient &&)

Copy and move support

Parameter
Name	Description
	`AdviceClient &&`

Returns
Type	Description
`AdviceClient &`

Functions

CalendarMode(std::string const &, std::string const &, google::cloud::cpp::compute::v1::CalendarModeAdviceRequest const &, Options)

Advise how, where and when to create the requested amount of instances with specified accelerators, within the specified time and location limits.

The method recommends creating future reservations for the requested resources. https://cloud.google.com/compute/docs/reference/rest/v1/advice/calendarMode

Parameters
Name	Description
`project`	`std::string const &` Project ID for this request.
`region`	`std::string const &` Name of the region for this request.
`calendar_mode_advice_request_resource`	`google::cloud::cpp::compute::v1::CalendarModeAdviceRequest const &` The CalendarModeAdviceRequest 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::CalendarModeAdviceResponse >`	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.CalendarModeAdviceResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CalendarMode(google::cloud::cpp::compute::advice::v1::CalendarModeRequest const &, Options)

Advise how, where and when to create the requested amount of instances with specified accelerators, within the specified time and location limits.

The method recommends creating future reservations for the requested resources. https://cloud.google.com/compute/docs/reference/rest/v1/advice/calendarMode

Parameters
Name	Description
`request`	`google::cloud::cpp::compute::advice::v1::CalendarModeRequest 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.advice.v1.CalendarModeRequest. 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::CalendarModeAdviceResponse >`	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.CalendarModeAdviceResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

Capacity(std::string const &, std::string const &, google::cloud::cpp::compute::v1::CapacityAdviceRequest const &, Options)

Advice on making real-time decisions (such as choosing zone or machine types) during deployment to maximize your chances of obtaining capacity.

https://cloud.google.com/compute/docs/reference/rest/v1/advice/capacity

Parameters
Name	Description
`project`	`std::string const &` Project ID for this request.
`region`	`std::string const &` Name of the region for this request.
`capacity_advice_request_resource`	`google::cloud::cpp::compute::v1::CapacityAdviceRequest const &` The CapacityAdviceRequest 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::CapacityAdviceResponse >`	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.CapacityAdviceResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

Capacity(google::cloud::cpp::compute::advice::v1::CapacityRequest const &, Options)

Advice on making real-time decisions (such as choosing zone or machine types) during deployment to maximize your chances of obtaining capacity.

https://cloud.google.com/compute/docs/reference/rest/v1/advice/capacity

Parameters
Name	Description
`request`	`google::cloud::cpp::compute::advice::v1::CapacityRequest 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.advice.v1.CapacityRequest. 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::CapacityAdviceResponse >`	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.CapacityAdviceResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CapacityHistory(std::string const &, std::string const &, google::cloud::cpp::compute::v1::CapacityHistoryRequest const &, Options)

Gets the capacity history.

https://cloud.google.com/compute/docs/reference/rest/v1/advice/capacityHistory

Parameters
Name	Description
`project`	`std::string const &` Project ID for this request.
`region`	`std::string const &` Name of the region for this request.
`capacity_history_request_resource`	`google::cloud::cpp::compute::v1::CapacityHistoryRequest const &` The CapacityHistoryRequest 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::CapacityHistoryResponse >`	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.CapacityHistoryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CapacityHistory(google::cloud::cpp::compute::advice::v1::CapacityHistoryRequest const &, Options)

Gets the capacity history.

https://cloud.google.com/compute/docs/reference/rest/v1/advice/capacityHistory

Parameters
Name	Description
`request`	`google::cloud::cpp::compute::advice::v1::CapacityHistoryRequest 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.advice.v1.CapacityHistoryRequest. 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::CapacityHistoryResponse >`	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.CapacityHistoryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.