Struct InstanceGroupManagerUpdatePolicy 

#[non_exhaustive]
pub struct InstanceGroupManagerUpdatePolicy {
    pub instance_redistribution_type: Option<InstanceRedistributionType>,
    pub max_surge: Option<FixedOrPercent>,
    pub max_unavailable: Option<FixedOrPercent>,
    pub minimal_action: Option<MinimalAction>,
    pub most_disruptive_allowed_action: Option<MostDisruptiveAllowedAction>,
    pub replacement_method: Option<ReplacementMethod>,
    pub type: Option<Type>,
    /* private fields */
}

Available on crate features instance-group-managers or region-instance-group-managers only.

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.

instance_redistribution_type: Option<InstanceRedistributionType>

The instance redistribution policy for regional managed instance groups. Valid values are:

• PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.
• NONE: For non-autoscaled groups, proactive redistribution is disabled.

max_surge: Option<FixedOrPercent>

The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.

At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.

max_unavailable: Option<FixedOrPercent>

The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:

 - The instance's status is
 RUNNING.

• If there is a health check on the instance group, the instance’s health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available.

This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.

At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.

minimal_action: Option<MinimalAction>

Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary.

• To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update.
• To apply a more disruptive action than is strictly necessary, set the minimal action to RESTART or REPLACE. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to RESTART in order to pick up metadata changes.

most_disruptive_allowed_action: Option<MostDisruptiveAllowedAction>

Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption as much as possible. RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.

replacement_method: Option<ReplacementMethod>

What action should be used to replace instances. See minimal_action.REPLACE

type: Option<Type>

The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want to update.

Implementations

impl InstanceGroupManagerUpdatePolicy

pub fn new() -> Self

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

where T: Into<InstanceRedistributionType>,

Sets the value of instance_redistribution_type.

Example

use google_cloud_compute_v1::model::instance_group_manager_update_policy::InstanceRedistributionType;
let x0 = InstanceGroupManagerUpdatePolicy::new().set_instance_redistribution_type(InstanceRedistributionType::Proactive);

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

where T: Into<InstanceRedistributionType>,

Sets or clears the value of instance_redistribution_type.

Example

use google_cloud_compute_v1::model::instance_group_manager_update_policy::InstanceRedistributionType;
let x0 = InstanceGroupManagerUpdatePolicy::new().set_or_clear_instance_redistribution_type(Some(InstanceRedistributionType::Proactive));
let x_none = InstanceGroupManagerUpdatePolicy::new().set_or_clear_instance_redistribution_type(None::<InstanceRedistributionType>);

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

where T: Into<FixedOrPercent>,

Sets the value of max_surge.

Example

use google_cloud_compute_v1::model::FixedOrPercent;
let x = InstanceGroupManagerUpdatePolicy::new().set_max_surge(FixedOrPercent::default()/* use setters */);

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

where T: Into<FixedOrPercent>,

Sets or clears the value of max_surge.

Example

use google_cloud_compute_v1::model::FixedOrPercent;
let x = InstanceGroupManagerUpdatePolicy::new().set_or_clear_max_surge(Some(FixedOrPercent::default()/* use setters */));
let x = InstanceGroupManagerUpdatePolicy::new().set_or_clear_max_surge(None::<FixedOrPercent>);

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

where T: Into<FixedOrPercent>,

Sets the value of max_unavailable.

Example

use google_cloud_compute_v1::model::FixedOrPercent;
let x = InstanceGroupManagerUpdatePolicy::new().set_max_unavailable(FixedOrPercent::default()/* use setters */);

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

where T: Into<FixedOrPercent>,

Sets or clears the value of max_unavailable.

Example

use google_cloud_compute_v1::model::FixedOrPercent;
let x = InstanceGroupManagerUpdatePolicy::new().set_or_clear_max_unavailable(Some(FixedOrPercent::default()/* use setters */));
let x = InstanceGroupManagerUpdatePolicy::new().set_or_clear_max_unavailable(None::<FixedOrPercent>);

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

where T: Into<MinimalAction>,

Sets the value of minimal_action.

Example

use google_cloud_compute_v1::model::instance_group_manager_update_policy::MinimalAction;
let x0 = InstanceGroupManagerUpdatePolicy::new().set_minimal_action(MinimalAction::Refresh);
let x1 = InstanceGroupManagerUpdatePolicy::new().set_minimal_action(MinimalAction::Replace);
let x2 = InstanceGroupManagerUpdatePolicy::new().set_minimal_action(MinimalAction::Restart);

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

where T: Into<MinimalAction>,

Sets or clears the value of minimal_action.

Example

use google_cloud_compute_v1::model::instance_group_manager_update_policy::MinimalAction;
let x0 = InstanceGroupManagerUpdatePolicy::new().set_or_clear_minimal_action(Some(MinimalAction::Refresh));
let x1 = InstanceGroupManagerUpdatePolicy::new().set_or_clear_minimal_action(Some(MinimalAction::Replace));
let x2 = InstanceGroupManagerUpdatePolicy::new().set_or_clear_minimal_action(Some(MinimalAction::Restart));
let x_none = InstanceGroupManagerUpdatePolicy::new().set_or_clear_minimal_action(None::<MinimalAction>);

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

where T: Into<MostDisruptiveAllowedAction>,

Sets the value of most_disruptive_allowed_action.

Example

use google_cloud_compute_v1::model::instance_group_manager_update_policy::MostDisruptiveAllowedAction;
let x0 = InstanceGroupManagerUpdatePolicy::new().set_most_disruptive_allowed_action(MostDisruptiveAllowedAction::Refresh);
let x1 = InstanceGroupManagerUpdatePolicy::new().set_most_disruptive_allowed_action(MostDisruptiveAllowedAction::Replace);
let x2 = InstanceGroupManagerUpdatePolicy::new().set_most_disruptive_allowed_action(MostDisruptiveAllowedAction::Restart);

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

where T: Into<MostDisruptiveAllowedAction>,

Sets or clears the value of most_disruptive_allowed_action.

Example

use google_cloud_compute_v1::model::instance_group_manager_update_policy::MostDisruptiveAllowedAction;
let x0 = InstanceGroupManagerUpdatePolicy::new().set_or_clear_most_disruptive_allowed_action(Some(MostDisruptiveAllowedAction::Refresh));
let x1 = InstanceGroupManagerUpdatePolicy::new().set_or_clear_most_disruptive_allowed_action(Some(MostDisruptiveAllowedAction::Replace));
let x2 = InstanceGroupManagerUpdatePolicy::new().set_or_clear_most_disruptive_allowed_action(Some(MostDisruptiveAllowedAction::Restart));
let x_none = InstanceGroupManagerUpdatePolicy::new().set_or_clear_most_disruptive_allowed_action(None::<MostDisruptiveAllowedAction>);

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

where T: Into<ReplacementMethod>,

Sets the value of replacement_method.

Example

use google_cloud_compute_v1::model::instance_group_manager_update_policy::ReplacementMethod;
let x0 = InstanceGroupManagerUpdatePolicy::new().set_replacement_method(ReplacementMethod::Substitute);

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

where T: Into<ReplacementMethod>,

Sets or clears the value of replacement_method.

Example

use google_cloud_compute_v1::model::instance_group_manager_update_policy::ReplacementMethod;
let x0 = InstanceGroupManagerUpdatePolicy::new().set_or_clear_replacement_method(Some(ReplacementMethod::Substitute));
let x_none = InstanceGroupManagerUpdatePolicy::new().set_or_clear_replacement_method(None::<ReplacementMethod>);

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

where T: Into<Type>,

Sets the value of r#type.

Example

use google_cloud_compute_v1::model::instance_group_manager_update_policy::Type;
let x0 = InstanceGroupManagerUpdatePolicy::new().set_type(Type::Proactive);

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

where T: Into<Type>,

Sets or clears the value of r#type.

Example

use google_cloud_compute_v1::model::instance_group_manager_update_policy::Type;
let x0 = InstanceGroupManagerUpdatePolicy::new().set_or_clear_type(Some(Type::Proactive));
let x_none = InstanceGroupManagerUpdatePolicy::new().set_or_clear_type(None::<Type>);

Trait Implementations

impl Clone for InstanceGroupManagerUpdatePolicy

fn clone(&self) -> InstanceGroupManagerUpdatePolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceGroupManagerUpdatePolicy

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

Formats the value using the given formatter.

impl Default for InstanceGroupManagerUpdatePolicy

fn default() -> InstanceGroupManagerUpdatePolicy

Returns the “default value” for a type.

impl Message for InstanceGroupManagerUpdatePolicy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for InstanceGroupManagerUpdatePolicy

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for InstanceGroupManagerUpdatePolicy