Struct Rollout 

#[non_exhaustive]
pub struct Rollout {

    pub name: String,
    pub uid: String,
    pub description: String,
    pub annotations: HashMap<String, String>,
    pub labels: HashMap<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: ApprovalState,
    pub state: State,
    pub failure_reason: String,
    pub deploying_build: String,
    pub etag: String,
    pub deploy_failure_cause: FailureCause,
    pub phases: Vec<Phase>,
    pub metadata: Option<Metadata>,
    pub controller_rollout: String,
    pub rollback_of_rollout: String,
    pub rolled_back_by_rollouts: Vec<String>,
    pub active_repair_automation_run: String,
    /* private fields */
}

A Rollout resource in the Cloud Deploy API.

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

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

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

annotations: HashMap<String, String>

Optional. 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: HashMap<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: ApprovalState

Output only. Approval state of the Rollout.

state: State

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: FailureCause

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.

active_repair_automation_run: String

Output only. The AutomationRun actively repairing the rollout.

Implementations

impl Rollout

pub fn new() -> Self

Creates a new default instance.

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = Rollout::new().set_name(format!("projects/{project_id}/locations/{location_id}/deliveryPipelines/{delivery_pipeline_id}/releases/{release_id}/rollouts/{rollout_id}"));

pub fn set_uid<T: Into<String>>(self, v: T) -> Self

Sets the value of uid.

Example

let x = Rollout::new().set_uid("example");

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

Example

let x = Rollout::new().set_description("example");

pub fn set_annotations<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of annotations.

Example

let x = Rollout::new().set_annotations([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = Rollout::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = Rollout::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = Rollout::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Rollout::new().set_or_clear_create_time(None::<Timestamp>);

pub fn set_approve_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of approve_time.

Example

use wkt::Timestamp;
let x = Rollout::new().set_approve_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_approve_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of approve_time.

Example

use wkt::Timestamp;
let x = Rollout::new().set_or_clear_approve_time(Some(Timestamp::default()/* use setters */));
let x = Rollout::new().set_or_clear_approve_time(None::<Timestamp>);

pub fn set_enqueue_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of enqueue_time.

Example

use wkt::Timestamp;
let x = Rollout::new().set_enqueue_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_enqueue_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of enqueue_time.

Example

use wkt::Timestamp;
let x = Rollout::new().set_or_clear_enqueue_time(Some(Timestamp::default()/* use setters */));
let x = Rollout::new().set_or_clear_enqueue_time(None::<Timestamp>);

pub fn set_deploy_start_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of deploy_start_time.

Example

use wkt::Timestamp;
let x = Rollout::new().set_deploy_start_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_deploy_start_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of deploy_start_time.

Example

use wkt::Timestamp;
let x = Rollout::new().set_or_clear_deploy_start_time(Some(Timestamp::default()/* use setters */));
let x = Rollout::new().set_or_clear_deploy_start_time(None::<Timestamp>);

pub fn set_deploy_end_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of deploy_end_time.

Example

use wkt::Timestamp;
let x = Rollout::new().set_deploy_end_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_deploy_end_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of deploy_end_time.

Example

use wkt::Timestamp;
let x = Rollout::new().set_or_clear_deploy_end_time(Some(Timestamp::default()/* use setters */));
let x = Rollout::new().set_or_clear_deploy_end_time(None::<Timestamp>);

pub fn set_target_id<T: Into<String>>(self, v: T) -> Self

Sets the value of target_id.

Example

let x = Rollout::new().set_target_id("example");

pub fn set_approval_state<T: Into<ApprovalState>>(self, v: T) -> Self

Sets the value of approval_state.

Example

use google_cloud_deploy_v1::model::rollout::ApprovalState;
let x0 = Rollout::new().set_approval_state(ApprovalState::NeedsApproval);
let x1 = Rollout::new().set_approval_state(ApprovalState::DoesNotNeedApproval);
let x2 = Rollout::new().set_approval_state(ApprovalState::Approved);

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_deploy_v1::model::rollout::State;
let x0 = Rollout::new().set_state(State::Succeeded);
let x1 = Rollout::new().set_state(State::Failed);
let x2 = Rollout::new().set_state(State::InProgress);

pub fn set_failure_reason<T: Into<String>>(self, v: T) -> Self

Sets the value of failure_reason.

Example

let x = Rollout::new().set_failure_reason("example");

pub fn set_deploying_build<T: Into<String>>(self, v: T) -> Self

Sets the value of deploying_build.

Example

let x = Rollout::new().set_deploying_build("example");

pub fn set_etag<T: Into<String>>(self, v: T) -> Self

Sets the value of etag.

Example

let x = Rollout::new().set_etag("example");

pub fn set_deploy_failure_cause<T: Into<FailureCause>>(self, v: T) -> Self

Sets the value of deploy_failure_cause.

Example

use google_cloud_deploy_v1::model::rollout::FailureCause;
let x0 = Rollout::new().set_deploy_failure_cause(FailureCause::CloudBuildUnavailable);
let x1 = Rollout::new().set_deploy_failure_cause(FailureCause::ExecutionFailed);
let x2 = Rollout::new().set_deploy_failure_cause(FailureCause::DeadlineExceeded);

pub fn set_phases<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Phase>,

Sets the value of phases.

Example

use google_cloud_deploy_v1::model::Phase;
let x = Rollout::new()
    .set_phases([
        Phase::default()/* use setters */,
        Phase::default()/* use (different) setters */,
    ]);

pub fn set_metadata<T>(self, v: T) -> Self

where T: Into<Metadata>,

Sets the value of metadata.

Example

use google_cloud_deploy_v1::model::Metadata;
let x = Rollout::new().set_metadata(Metadata::default()/* use setters */);

pub fn set_or_clear_metadata<T>(self, v: Option<T>) -> Self

where T: Into<Metadata>,

Sets or clears the value of metadata.

Example

use google_cloud_deploy_v1::model::Metadata;
let x = Rollout::new().set_or_clear_metadata(Some(Metadata::default()/* use setters */));
let x = Rollout::new().set_or_clear_metadata(None::<Metadata>);

pub fn set_controller_rollout<T: Into<String>>(self, v: T) -> Self

Sets the value of controller_rollout.

Example

let x = Rollout::new().set_controller_rollout("example");

pub fn set_rollback_of_rollout<T: Into<String>>(self, v: T) -> Self

Sets the value of rollback_of_rollout.

Example

let x = Rollout::new().set_rollback_of_rollout("example");

pub fn set_rolled_back_by_rollouts<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of rolled_back_by_rollouts.

Example

let x = Rollout::new().set_rolled_back_by_rollouts(["a", "b", "c"]);

pub fn set_active_repair_automation_run<T: Into<String>>(self, v: T) -> Self

Sets the value of active_repair_automation_run.

Example

let x = Rollout::new().set_active_repair_automation_run("example");

Trait Implementations

impl Clone for Rollout

fn clone(&self) -> Rollout

Returns a duplicate 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() -> Rollout

Returns the “default value” for a type.

impl Message for Rollout

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Rollout

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Rollout