Rollout class

Creates a new Rollout in a given project and location. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

Constructors

Rollout(String name, {RolloutArgs? args, CustomResourceOptions? options})

Creates a new Rollout. name The Pulumi resource name. args Arguments used to configure this Rollout. The set of arguments for Rollout. options Resource options controlling this resource's behavior.

Properties

annotations ↔ Output<Map<String, String>>

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.

late, final

approvalState ↔ Output<String>

Approval state of the Rollout.

late, final

approveTime ↔ Output<String>

Time at which the Rollout was approved.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

controllerRollout ↔ Output<String>

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

late, final

createTime ↔ Output<String>

Time at which the Rollout was created.

late, final

deliveryPipelineId ↔ Output<String>

late, final

deployEndTime ↔ Output<String>

Time at which the Rollout finished deploying.

late, final

deployFailureCause ↔ Output<String>

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

late, final

deployingBuild ↔ Output<String>

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

late, final

deployStartTime ↔ Output<String>

Time at which the Rollout started deploying.

late, final

description ↔ Output<String>

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

late, final

enqueueTime ↔ Output<String>

Time at which the Rollout was enqueued.

late, final

etag ↔ Output<String>

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.

late, final

failureReason ↔ Output<String>

Additional information about the rollout failure, if available.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>>

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.

late, final

location ↔ Output<String>

late, final

metadata ↔ Output<MetadataResponse>

Metadata contains information about the rollout.

late, final

name ↔ Output<String>

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

late, final

phases ↔ Output<List<Map<String, dynamic>>>

The phases that represent the workflows of this Rollout.

late, final

project ↔ Output<String>

late, final

releaseId ↔ Output<String>

late, final

requestId ↔ Output<String?>

Optional. A 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. The server will guarantee that for at least 60 minutes since the first request. 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).

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

rollbackOfRollout ↔ Output<String>

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

late, final

rolledBackByRollouts ↔ Output<List<String>>

Names of Rollouts that rolled back this Rollout.

late, final

rolloutId ↔ Output<String>

Required. ID of the Rollout.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

startingPhaseId ↔ Output<String?>

Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

late, final

state ↔ Output<String>

Current state of the Rollout.

late, final

targetId ↔ Output<String>

The ID of Target to which this Rollout is deploying.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

Unique identifier of the Rollout.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited