Compute Engine v1 API - Class CancelRolloutRequest (3.28.0)

public sealed class CancelRolloutRequest : IMessage<CancelRolloutRequest>, IEquatable<CancelRolloutRequest>, IDeepCloneable<CancelRolloutRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class CancelRolloutRequest.

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

Inheritance

object > CancelRolloutRequest

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

CancelRolloutRequest()

public CancelRolloutRequest()

CancelRolloutRequest(CancelRolloutRequest)

public CancelRolloutRequest(CancelRolloutRequest other)
Parameter
Name Description
other CancelRolloutRequest

Properties

HasRequestId

public bool HasRequestId { get; }

Gets whether the "request_id" field is set

Property Value
Type Description
bool

HasRollback

public bool HasRollback { get; }

Gets whether the "rollback" field is set

Property Value
Type Description
bool

Project

public string Project { get; set; }

Project ID for this request.

Property Value
Type Description
string

RequestId

public string RequestId { get; set; }

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

Property Value
Type Description
string

Rollback

public bool Rollback { get; set; }

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.

Property Value
Type Description
bool

Rollout

public string Rollout { get; set; }

Name of the Rollout resource to cancel.

Property Value
Type Description
string