Struct google_api_proto::google::cloud::deploy::v1::Rollout

pub struct Rollout {

    pub name: String,
    pub uid: String,
    pub description: String,
    pub annotations: BTreeMap<String, String>,
    pub labels: BTreeMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub approve_time: Option<Timestamp>,
    pub enqueue_time: Option<Timestamp>,
    pub deploy_start_time: Option<Timestamp>,
    pub deploy_end_time: Option<Timestamp>,
    pub target_id: String,
    pub approval_state: i32,
    pub state: i32,
    pub failure_reason: String,
    pub deploying_build: String,
    pub etag: String,
    pub deploy_failure_cause: i32,
    pub phases: Vec<Phase>,
    pub metadata: Option<Metadata>,
    pub controller_rollout: String,
    pub rollback_of_rollout: String,
    pub rolled_back_by_rollouts: Vec<String>,
}

A Rollout resource in the Cloud Deploy API.

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

Fields

name: String

Optional. 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\])?

uid: String

Output only. Unique identifier of the Rollout.

description: String

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

annotations: BTreeMap<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.

labels: BTreeMap<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.

create_time: Option<Timestamp>

Output only. Time at which the Rollout was created.

approve_time: Option<Timestamp>

Output only. Time at which the Rollout was approved.

enqueue_time: Option<Timestamp>

Output only. Time at which the Rollout was enqueued.

deploy_start_time: Option<Timestamp>

Output only. Time at which the Rollout started deploying.

deploy_end_time: Option<Timestamp>

Output only. Time at which the Rollout finished deploying.

target_id: String

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

approval_state: i32

Output only. Approval state of the Rollout.

state: i32

Output only. Current state of the Rollout.

failure_reason: String

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

deploying_build: String

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

etag: 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.

deploy_failure_cause: i32

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

phases: Vec<Phase>

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

metadata: Option<Metadata>

Output only. Metadata contains information about the rollout.

controller_rollout: String

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

rollback_of_rollout: String

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

rolled_back_by_rollouts: Vec<String>

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

Implementations

impl Rollout

pub fn approval_state(&self) -> ApprovalState

Returns the enum value of approval_state, or the default if the field is set to an invalid enum value.

pub fn set_approval_state(&mut self, value: ApprovalState)

Sets approval_state to the provided enum value.

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn deploy_failure_cause(&self) -> FailureCause

Returns the enum value of deploy_failure_cause, or the default if the field is set to an invalid enum value.

pub fn set_deploy_failure_cause(&mut self, value: FailureCause)

Sets deploy_failure_cause to the provided enum value.

Trait Implementations

impl Clone for Rollout

fn clone(&self) -> Rollout

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Rollout

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Rollout

fn default() -> Self

Returns the “default value” for a type.

impl Message for Rollout

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Rollout

fn eq(&self, other: &Rollout) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Rollout