Class Rollout (2.0.0)

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

A Rollout resource in the Google Cloud Deploy API.

A Rollout contains information around a specific deployment to a Target.

Inheritance

Object > Rollout

Implements

IMessage<Rollout>, IEquatable<Rollout>, IDeepCloneable<Rollout>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

Rollout()

public Rollout()

Rollout(Rollout)

public Rollout(Rollout other)

Parameter
Name	Description
`other`	`Rollout`

Properties

Annotations

public MapField<string, string> Annotations { get; }

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

Property Value
Type	Description
`MapField<String, String>`

ApprovalState

public Rollout.Types.ApprovalState ApprovalState { get; set; }

Output only. Approval state of the Rollout.

Property Value
Type	Description
`Rollout.Types.ApprovalState`

ApproveTime

public Timestamp ApproveTime { get; set; }

Output only. Time at which the Rollout was approved.

Property Value
Type	Description
`Timestamp`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Time at which the Rollout was created.

Property Value
Type	Description
`Timestamp`

DeployEndTime

public Timestamp DeployEndTime { get; set; }

Output only. Time at which the Rollout finished deploying.

Property Value
Type	Description
`Timestamp`

DeployFailureCause

public Rollout.Types.FailureCause DeployFailureCause { get; set; }

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

Property Value
Type	Description
`Rollout.Types.FailureCause`

DeployingBuild

public string DeployingBuild { get; set; }

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

Property Value
Type	Description
`String`

DeployingBuildAsBuildName

public BuildName DeployingBuildAsBuildName { get; set; }

BuildName-typed view over the DeployingBuild resource name property.

Property Value
Type	Description
`BuildName`

DeployStartTime

public Timestamp DeployStartTime { get; set; }

Output only. Time at which the Rollout started deploying.

Property Value
Type	Description
`Timestamp`

Description

public string Description { get; set; }

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

Property Value
Type	Description
`String`

EnqueueTime

public Timestamp EnqueueTime { get; set; }

Output only. Time at which the Rollout was enqueued.

Property Value
Type	Description
`Timestamp`

Etag

public string Etag { get; set; }

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.

Property Value
Type	Description
`String`

FailureReason

public string FailureReason { get; set; }

Output only. Reason the build failed. Empty if the build succeeded.

Property Value
Type	Description
`String`

Labels

public MapField<string, string> Labels { get; }

Labels are attributes that can be set and used by both the user and by Google 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.

Property Value
Type	Description
`MapField<String, String>`

Name

public string Name { get; set; }

Optional. Name of the Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/[a-z][a-z0-9-]{0,62}.

Property Value
Type	Description
`String`

RolloutName

public RolloutName RolloutName { get; set; }

RolloutName-typed view over the Name resource name property.

Property Value
Type	Description
`RolloutName`

State

public Rollout.Types.State State { get; set; }

Output only. Current state of the Rollout.

Property Value
Type	Description
`Rollout.Types.State`

TargetId

public string TargetId { get; set; }

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

Property Value
Type	Description
`String`

Uid

public string Uid { get; set; }

Output only. Unique identifier of the Rollout.

Property Value
Type	Description
`String`