RolloutArgs class

The set of arguments for Rollout. The set of arguments for Rollout.

Constructors

RolloutArgs({Input<Map<String, String>>? annotations, required Input<String> deliveryPipelineId, Input<String>? description, Input<String>? etag, Input<Map<String, String>>? labels, Input<String>? location, Input<String>? name, Input<String>? project, required Input<String> releaseId, Input<String>? requestId, required Input<String> rolloutId, Input<String>? startingPhaseId, required Input<String> targetId})
Creates a new RolloutArgs. annotations 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. deliveryPipelineId Required. description Description of the Rollout for user purposes. Max length is 255 characters. 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. 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. location Optional. name Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}. project Optional. releaseId Required. requestId 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). rolloutId Required. ID of the Rollout. startingPhaseId Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase. targetId The ID of Target to which this Rollout is deploying.
const
RolloutArgs.fromMap(Map<String, dynamic> map)
factory

Properties

annotations → Input<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.
final
deliveryPipelineId → Input<String>
final
description → Input<String>?
Description of the Rollout for user purposes. Max length is 255 characters.
final
etag → Input<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.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<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.
final
location → Input<String>?
final
name → Input<String>?
Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.
final
project → Input<String>?
final
releaseId → Input<String>
final
requestId → Input<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).
final
rolloutId → Input<String>
Required. ID of the Rollout.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startingPhaseId → Input<String>?
Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.
final
targetId → Input<String>
The ID of Target to which this Rollout is deploying.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited