Rollout

import type { Rollout } from "https://googleapis.deno.dev/v1/clouddeploy:v1.ts";

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

interface Rollout {

annotations?: {

[key: string]: string;

};

readonly approvalState?:

| "APPROVAL_STATE_UNSPECIFIED"

| "NEEDS_APPROVAL"

| "DOES_NOT_NEED_APPROVAL"

| "APPROVED"

| "REJECTED";

readonly approveTime?: Date;

readonly controllerRollout?: string;

readonly createTime?: Date;

readonly deployEndTime?: Date;

readonly deployFailureCause?:

| "FAILURE_CAUSE_UNSPECIFIED"

| "CLOUD_BUILD_UNAVAILABLE"

| "EXECUTION_FAILED"

| "DEADLINE_EXCEEDED"

| "RELEASE_FAILED"

| "RELEASE_ABANDONED"

| "VERIFICATION_CONFIG_NOT_FOUND"

| "CLOUD_BUILD_REQUEST_FAILED"

| "OPERATION_FEATURE_NOT_SUPPORTED";

readonly deployingBuild?: string;

readonly deployStartTime?: Date;

description?: string;

readonly enqueueTime?: Date;

etag?: string;

readonly failureReason?: string;

labels?: {

[key: string]: string;

};

readonly metadata?: Metadata;

name?: string;

readonly phases?: Phase[];

readonly rollbackOfRollout?: string;

readonly rolledBackByRollouts?: string[];

readonly state?:

| "STATE_UNSPECIFIED"

| "SUCCEEDED"

| "FAILED"

| "IN_PROGRESS"

| "PENDING_APPROVAL"

| "APPROVAL_REJECTED"

| "PENDING"

| "PENDING_RELEASE"

| "CANCELLING"

| "CANCELLED"

| "HALTED";

targetId?: string;

readonly uid?: string;

}

§Properties

annotations?: {

[key: string]: string;

}

[src]

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.

readonly approvalState?: "APPROVAL_STATE_UNSPECIFIED" | "NEEDS_APPROVAL" | "DOES_NOT_NEED_APPROVAL" | "APPROVED" | "REJECTED"

[src]

Output only. Approval state of the Rollout.

readonly approveTime?: Date

[src]

Output only. Time at which the Rollout was approved.

readonly controllerRollout?: string

[src]

Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.

readonly createTime?: Date

[src]

Output only. Time at which the Rollout was created.

readonly deployEndTime?: Date

[src]

Output only. Time at which the Rollout finished deploying.

[src]

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

readonly deployingBuild?: string

[src]

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

readonly deployStartTime?: Date

[src]

Output only. Time at which the Rollout started deploying.

description?: string

[src]

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

readonly enqueueTime?: Date

[src]

Output only. Time at which the Rollout was enqueued.

etag?: string

[src]

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.

readonly failureReason?: string

[src]

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

labels?: {

[key: string]: string;

}

[src]

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.

readonly metadata?: Metadata

[src]

Output only. Metadata contains information about the rollout.

name?: string

[src]

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

readonly phases?: Phase[]

[src]

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

readonly rollbackOfRollout?: string

[src]

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

readonly rolledBackByRollouts?: string[]

[src]

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

[src]

Output only. Current state of the Rollout.

targetId?: string

[src]

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

readonly uid?: string

[src]

Output only. Unique identifier of the Rollout.