Class Rollout

A Rollout resource in the Cloud Deploy API. A Rollout contains information around a specific deployment to a Target.

Inheritance

object

Rollout

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudDeploy.v1.Data

Assembly: Google.Apis.CloudDeploy.v1.dll

Syntax

public class Rollout : IDirectResponseSchema

Properties

ActiveRepairAutomationRun

Output only. The AutomationRun actively repairing the rollout.

Declaration

[JsonProperty("activeRepairAutomationRun")]
public virtual string ActiveRepairAutomationRun { get; set; }

Property Value

Type	Description
string

Annotations

Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

Declaration

[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }

Property Value

Type	Description
IDictionary<string, string>

ApprovalState

Output only. Approval state of the Rollout.

Declaration

[JsonProperty("approvalState")]
public virtual string ApprovalState { get; set; }

Property Value

Type	Description
string

ApproveTime

object representation of ApproveTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ApproveTimeDateTimeOffset instead.")]
public virtual object ApproveTime { get; set; }

Property Value

Type	Description
object

ApproveTimeDateTimeOffset

DateTimeOffset representation of ApproveTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? ApproveTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

ApproveTimeRaw

Output only. Time at which the Rollout was approved.

Declaration

[JsonProperty("approveTime")]
public virtual string ApproveTimeRaw { get; set; }

Property Value

Type	Description
string

ControllerRollout

Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Declaration

[JsonProperty("controllerRollout")]
public virtual string ControllerRollout { get; set; }

Property Value

Type	Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. Time at which the Rollout was created.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

DeployEndTime

object representation of DeployEndTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeployEndTimeDateTimeOffset instead.")]
public virtual object DeployEndTime { get; set; }

Property Value

Type	Description
object

DeployEndTimeDateTimeOffset

DateTimeOffset representation of DeployEndTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? DeployEndTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

DeployEndTimeRaw

Output only. Time at which the Rollout finished deploying.

Declaration

[JsonProperty("deployEndTime")]
public virtual string DeployEndTimeRaw { get; set; }

Property Value

Type	Description
string

DeployFailureCause

Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.

Declaration

[JsonProperty("deployFailureCause")]
public virtual string DeployFailureCause { get; set; }

Property Value

Type	Description
string

DeployStartTime

object representation of DeployStartTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeployStartTimeDateTimeOffset instead.")]
public virtual object DeployStartTime { get; set; }

Property Value

Type	Description
object

DeployStartTimeDateTimeOffset

DateTimeOffset representation of DeployStartTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? DeployStartTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

DeployStartTimeRaw

Output only. Time at which the Rollout started deploying.

Declaration

[JsonProperty("deployStartTime")]
public virtual string DeployStartTimeRaw { get; set; }

Property Value

Type	Description
string

DeployingBuild

Output only. The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.

Declaration

[JsonProperty("deployingBuild")]
public virtual string DeployingBuild { get; set; }

Property Value

Type	Description
string

Description

Optional. Description of the Rollout for user purposes. Max length is 255 characters.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

ETag

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

EnqueueTime

object representation of EnqueueTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EnqueueTimeDateTimeOffset instead.")]
public virtual object EnqueueTime { get; set; }

Property Value

Type	Description
object

EnqueueTimeDateTimeOffset

DateTimeOffset representation of EnqueueTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? EnqueueTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

EnqueueTimeRaw

Output only. Time at which the Rollout was enqueued.

Declaration

[JsonProperty("enqueueTime")]
public virtual string EnqueueTimeRaw { get; set; }

Property Value

Type	Description
string

FailureReason

Output only. Additional information about the rollout failure, if available.

Declaration

[JsonProperty("failureReason")]
public virtual string FailureReason { get; set; }

Property Value

Type	Description
string

Labels

Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed.

• Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Metadata

Output only. Metadata contains information about the rollout.

Declaration

[JsonProperty("metadata")]
public virtual Metadata Metadata { get; set; }

Property Value

Type	Description
Metadata

Name

Identifier. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}. The rollout component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Phases

Output only. The phases that represent the workflows of this Rollout.

Declaration

[JsonProperty("phases")]
public virtual IList<Phase> Phases { get; set; }

Property Value

Type	Description
IList<Phase>

RollbackOfRollout

Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.

Declaration

[JsonProperty("rollbackOfRollout")]
public virtual string RollbackOfRollout { get; set; }

Property Value

Type	Description
string

RolledBackByRollouts

Output only. Names of Rollouts that rolled back this Rollout.

Declaration

[JsonProperty("rolledBackByRollouts")]
public virtual IList<string> RolledBackByRollouts { get; set; }

Property Value

Type	Description
IList<string>

State

Output only. Current state of the Rollout.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

TargetId

Required. The ID of Target to which this Rollout is deploying.

Declaration

[JsonProperty("targetId")]
public virtual string TargetId { get; set; }

Property Value

Type	Description
string

Uid

Output only. Unique identifier of the Rollout.

Declaration

[JsonProperty("uid")]
public virtual string Uid { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema