Class RolloutsClient (3.9.0-rc)

3.9.0-rc 3.8.0 (latest) 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 2.48.0-rc 2.47.1 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 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.1 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.1

Service for the rollouts resource.

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

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

RolloutsClient(RolloutsClient const &)

Copy and move support

Parameter
Name	Description
	RolloutsClient const &

RolloutsClient(RolloutsClient &&)

Copy and move support

Parameter
Name	Description
	RolloutsClient &&

RolloutsClient(std::shared_ptr< RolloutsConnection >, Options)

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

Operators

operator=(RolloutsClient const &)

Copy and move support

Parameter
Name	Description
	RolloutsClient const &

Returns
Type	Description
RolloutsClient &

operator=(RolloutsClient &&)

Copy and move support

Parameter
Name	Description
	RolloutsClient &&

Returns
Type	Description
RolloutsClient &

Functions

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

Advances a Rollout to the next wave, or completes it if no waves remain.

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

Parameters
Name	Description
project	std::string const & Required. Project ID for this request.
rollout	std::string const & Required. Name of the Rollout resource to advance.
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.

Advance(NoAwaitTag, std::string const &, std::string const &, Options)

Advances a Rollout to the next wave, or completes it if no waves remain.

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 &
rollout	std::string const &
opts	Options

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

Advance(google::cloud::cpp::compute::rollouts::v1::AdvanceRequest const &, Options)

Advances a Rollout to the next wave, or completes it if no waves remain.

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

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

Advance(NoAwaitTag, google::cloud::cpp::compute::rollouts::v1::AdvanceRequest const &, Options)

Advances a Rollout to the next wave, or completes it if no waves remain.

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::rollouts::v1::AdvanceRequest const &
opts	Options

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

Advance(google::cloud::cpp::compute::v1::Operation const &, Options)

Advances a Rollout to the next wave, or completes it if no waves remain.

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

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

Cancels a Rollout.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
rollout	std::string const & Name of the Rollout resource to cancel.
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(NoAwaitTag, std::string const &, std::string const &, Options)

Cancels a Rollout.

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 &
rollout	std::string const &
opts	Options

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

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

Cancels a Rollout.

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

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

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

Cancels a Rollout.

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::rollouts::v1::CancelRequest const &
opts	Options

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

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

Cancels a Rollout.

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

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

Deletes a Rollout.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
rollout	std::string const & Name of the Rollout resource 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.

DeleteRollout(NoAwaitTag, std::string const &, std::string const &, Options)

Deletes a Rollout.

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 &
rollout	std::string const &
opts	Options

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

DeleteRollout(google::cloud::cpp::compute::rollouts::v1::DeleteRolloutRequest const &, Options)

Deletes a Rollout.

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

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

DeleteRollout(NoAwaitTag, google::cloud::cpp::compute::rollouts::v1::DeleteRolloutRequest const &, Options)

Deletes a Rollout.

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::rollouts::v1::DeleteRolloutRequest const &
opts	Options

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

DeleteRollout(google::cloud::cpp::compute::v1::Operation const &, Options)

Deletes a Rollout.

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

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

Gets details of a single project-scoped Rollout.

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

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

GetRollout(google::cloud::cpp::compute::rollouts::v1::GetRolloutRequest const &, Options)

Gets details of a single project-scoped Rollout.

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

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

ListRollouts(std::string const &, Options)

Lists Rollouts in a given project and location.

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

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

ListRollouts(google::cloud::cpp::compute::rollouts::v1::ListRolloutsRequest, Options)

Lists Rollouts in a given project and location.

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

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

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

Pauses a Rollout.

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

Parameters
Name	Description
project	std::string const & Required. Project ID for this request.
rollout	std::string const & Required. Name of the Rollout resource to pause.
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.

Pause(NoAwaitTag, std::string const &, std::string const &, Options)

Pauses a Rollout.

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 &
rollout	std::string const &
opts	Options

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

Pause(google::cloud::cpp::compute::rollouts::v1::PauseRequest const &, Options)

Pauses a Rollout.

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

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

Pause(NoAwaitTag, google::cloud::cpp::compute::rollouts::v1::PauseRequest const &, Options)

Pauses a Rollout.

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::rollouts::v1::PauseRequest const &
opts	Options

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

Pause(google::cloud::cpp::compute::v1::Operation const &, Options)

Pauses a Rollout.

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

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

Resumes a Rollout.

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

Parameters
Name	Description
project	std::string const & Required. Project ID for this request.
rollout	std::string const & Required. Name of the Rollout resource to resume.
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.

Resume(NoAwaitTag, std::string const &, std::string const &, Options)

Resumes a Rollout.

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 &
rollout	std::string const &
opts	Options

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

Resume(google::cloud::cpp::compute::rollouts::v1::ResumeRequest const &, Options)

Resumes a Rollout.

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

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

Resume(NoAwaitTag, google::cloud::cpp::compute::rollouts::v1::ResumeRequest const &, Options)

Resumes a Rollout.

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::rollouts::v1::ResumeRequest const &
opts	Options

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

Resume(google::cloud::cpp::compute::v1::Operation const &, Options)

Resumes a Rollout.

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