Class InstanceGroupManagerResizeRequestsClient (2.26.0-rc)

Service for the instanceGroupManagerResizeRequests resource.

http://cloud.go888ogle.com.fqhub.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests

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

InstanceGroupManagerResizeRequestsClient(InstanceGroupManagerResizeRequestsClient const &)

Copy and move support

Parameter
Name Description
InstanceGroupManagerResizeRequestsClient const &

InstanceGroupManagerResizeRequestsClient(InstanceGroupManagerResizeRequestsClient &&)

Copy and move support

Parameter
Name Description
InstanceGroupManagerResizeRequestsClient &&

InstanceGroupManagerResizeRequestsClient(std::shared_ptr< InstanceGroupManagerResizeRequestsConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< InstanceGroupManagerResizeRequestsConnection >
opts Options

Operators

operator=(InstanceGroupManagerResizeRequestsClient const &)

Copy and move support

Parameter
Name Description
InstanceGroupManagerResizeRequestsClient const &
Returns
Type Description
InstanceGroupManagerResizeRequestsClient &

operator=(InstanceGroupManagerResizeRequestsClient &&)

Copy and move support

Parameter
Name Description
InstanceGroupManagerResizeRequestsClient &&
Returns
Type Description
InstanceGroupManagerResizeRequestsClient &

Functions

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

Cancels the specified resize request and removes it from the queue.

Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue. http://cloud.go888ogle.com.fqhub.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests/cancel

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located. The name should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.

resize_request std::string const &

The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID.

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.

Cancel(google::cloud::cpp::compute::instance_group_manager_resize_requests::v1::CancelRequest const &, Options)

Cancels the specified resize request and removes it from the queue.

Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue. http://cloud.go888ogle.com.fqhub.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests/cancel

Parameters
Name Description
request google::cloud::cpp::compute::instance_group_manager_resize_requests::v1::CancelRequest 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.instance_group_manager_resize_requests.v1.CancelRequest. 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.

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

Deletes the specified, inactive resize request.

Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. http://cloud.go888ogle.com.fqhub.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests/delete

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located. The name should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.

resize_request std::string const &

The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID.

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.

DeleteInstanceGroupManagerResizeRequest(google::cloud::cpp::compute::instance_group_manager_resize_requests::v1::DeleteInstanceGroupManagerResizeRequestRequest const &, Options)

Deletes the specified, inactive resize request.

Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. http://cloud.go888ogle.com.fqhub.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests/delete

Parameters
Name Description
request google::cloud::cpp::compute::instance_group_manager_resize_requests::v1::DeleteInstanceGroupManagerResizeRequestRequest 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.instance_group_manager_resize_requests.v1.DeleteInstanceGroupManagerResizeRequestRequest. 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.

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

Returns all of the details about the specified resize request.

http://cloud.go888ogle.com.fqhub.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests/get

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

Name of the href="/compute/docs/regions-zones/#available">zone scoping this request. Name should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.

resize_request std::string const &

The name of the resize request. Name should conform to RFC1035 or be a resource ID.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::InstanceGroupManagerResizeRequest >

the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InstanceGroupManagerResizeRequest) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetInstanceGroupManagerResizeRequest(google::cloud::cpp::compute::instance_group_manager_resize_requests::v1::GetInstanceGroupManagerResizeRequestRequest const &, Options)

Returns all of the details about the specified resize request.

http://cloud.go888ogle.com.fqhub.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests/get

Parameters
Name Description
request google::cloud::cpp::compute::instance_group_manager_resize_requests::v1::GetInstanceGroupManagerResizeRequestRequest 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.instance_group_manager_resize_requests.v1.GetInstanceGroupManagerResizeRequestRequest. 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::InstanceGroupManagerResizeRequest >

the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InstanceGroupManagerResizeRequest) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

InsertInstanceGroupManagerResizeRequest(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InstanceGroupManagerResizeRequest const &, Options)

Creates a new resize request that starts provisioning VMs immediately or queues VM creation.

http://cloud.go888ogle.com.fqhub.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests/insert

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID.

instance_group_manager_resize_request_resource google::cloud::cpp::compute::v1::InstanceGroupManagerResizeRequest const &

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

InsertInstanceGroupManagerResizeRequest(google::cloud::cpp::compute::instance_group_manager_resize_requests::v1::InsertInstanceGroupManagerResizeRequestRequest const &, Options)

Creates a new resize request that starts provisioning VMs immediately or queues VM creation.

http://cloud.go888ogle.com.fqhub.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests/insert

Parameters
Name Description
request google::cloud::cpp::compute::instance_group_manager_resize_requests::v1::InsertInstanceGroupManagerResizeRequestRequest 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.instance_group_manager_resize_requests.v1.InsertInstanceGroupManagerResizeRequestRequest. 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.

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

Retrieves a list of resize requests that are contained in the managed instance group.

http://cloud.go888ogle.com.fqhub.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests/list

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

The name of the zone where the managed instance group is located. The name should conform to RFC1035.

instance_group_manager std::string const &

The name of the managed instance group. The name should conform to RFC1035.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::cpp::compute::v1::InstanceGroupManagerResizeRequest >

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

ListInstanceGroupManagerResizeRequests(google::cloud::cpp::compute::instance_group_manager_resize_requests::v1::ListInstanceGroupManagerResizeRequestsRequest, Options)

Retrieves a list of resize requests that are contained in the managed instance group.

http://cloud.go888ogle.com.fqhub.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests/list

Parameters
Name Description
request google::cloud::cpp::compute::instance_group_manager_resize_requests::v1::ListInstanceGroupManagerResizeRequestsRequest

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.instance_group_manager_resize_requests.v1.ListInstanceGroupManagerResizeRequestsRequest. 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::InstanceGroupManagerResizeRequest >

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