Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::CancelRolloutRequest (v3.7.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::CancelRolloutRequest.

A request message for Rollouts.Cancel. See the method description for details.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#project

def project() -> ::String
Returns
  • (::String) — Project ID for this request.

#project=

def project=(value) -> ::String
Parameter
  • value (::String) — Project ID for this request.
Returns
  • (::String) — Project ID for this request.

#request_id

def request_id() -> ::String
Returns
  • (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

#request_id=

def request_id=(value) -> ::String
Parameter
  • value (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
  • (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

#rollback

def rollback() -> ::Boolean
Returns
  • (::Boolean) — Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel the rollout without taking any further actions. Note that products must support at least one of these options, however, it does not need to support both.

#rollback=

def rollback=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel the rollout without taking any further actions. Note that products must support at least one of these options, however, it does not need to support both.
Returns
  • (::Boolean) — Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel the rollout without taking any further actions. Note that products must support at least one of these options, however, it does not need to support both.

#rollout

def rollout() -> ::String
Returns
  • (::String) — Name of the Rollout resource to cancel.

#rollout=

def rollout=(value) -> ::String
Parameter
  • value (::String) — Name of the Rollout resource to cancel.
Returns
  • (::String) — Name of the Rollout resource to cancel.