1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateEndpointInput {
/// <p>The name of the endpoint whose configuration you want to update.</p>
pub endpoint_name: ::std::option::Option<::std::string::String>,
/// <p>The name of the new endpoint configuration.</p>
pub endpoint_config_name: ::std::option::Option<::std::string::String>,
/// <p>When updating endpoint resources, enables or disables the retention of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">variant properties</a>, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set <code>RetainAllVariantProperties</code> to <code>true</code>. To use the variant properties specified in a new <code>EndpointConfig</code> call when updating an endpoint, set <code>RetainAllVariantProperties</code> to <code>false</code>. The default is <code>false</code>.</p>
pub retain_all_variant_properties: ::std::option::Option<bool>,
/// <p>When you are updating endpoint resources with <code>RetainAllVariantProperties</code>, whose value is set to <code>true</code>, <code>ExcludeRetainedVariantProperties</code> specifies the list of type <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">VariantProperty</a> to override with the values provided by <code>EndpointConfig</code>. If you don't specify a value for <code>ExcludeRetainedVariantProperties</code>, no variant properties are overridden. </p>
pub exclude_retained_variant_properties: ::std::option::Option<::std::vec::Vec<crate::types::VariantProperty>>,
/// <p>The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.</p>
pub deployment_config: ::std::option::Option<crate::types::DeploymentConfig>,
/// <p>Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).</p>
pub retain_deployment_config: ::std::option::Option<bool>,
}
impl UpdateEndpointInput {
/// <p>The name of the endpoint whose configuration you want to update.</p>
pub fn endpoint_name(&self) -> ::std::option::Option<&str> {
self.endpoint_name.as_deref()
}
/// <p>The name of the new endpoint configuration.</p>
pub fn endpoint_config_name(&self) -> ::std::option::Option<&str> {
self.endpoint_config_name.as_deref()
}
/// <p>When updating endpoint resources, enables or disables the retention of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">variant properties</a>, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set <code>RetainAllVariantProperties</code> to <code>true</code>. To use the variant properties specified in a new <code>EndpointConfig</code> call when updating an endpoint, set <code>RetainAllVariantProperties</code> to <code>false</code>. The default is <code>false</code>.</p>
pub fn retain_all_variant_properties(&self) -> ::std::option::Option<bool> {
self.retain_all_variant_properties
}
/// <p>When you are updating endpoint resources with <code>RetainAllVariantProperties</code>, whose value is set to <code>true</code>, <code>ExcludeRetainedVariantProperties</code> specifies the list of type <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">VariantProperty</a> to override with the values provided by <code>EndpointConfig</code>. If you don't specify a value for <code>ExcludeRetainedVariantProperties</code>, no variant properties are overridden. </p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.exclude_retained_variant_properties.is_none()`.
pub fn exclude_retained_variant_properties(&self) -> &[crate::types::VariantProperty] {
self.exclude_retained_variant_properties.as_deref().unwrap_or_default()
}
/// <p>The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.</p>
pub fn deployment_config(&self) -> ::std::option::Option<&crate::types::DeploymentConfig> {
self.deployment_config.as_ref()
}
/// <p>Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).</p>
pub fn retain_deployment_config(&self) -> ::std::option::Option<bool> {
self.retain_deployment_config
}
}
impl UpdateEndpointInput {
/// Creates a new builder-style object to manufacture [`UpdateEndpointInput`](crate::operation::update_endpoint::UpdateEndpointInput).
pub fn builder() -> crate::operation::update_endpoint::builders::UpdateEndpointInputBuilder {
crate::operation::update_endpoint::builders::UpdateEndpointInputBuilder::default()
}
}
/// A builder for [`UpdateEndpointInput`](crate::operation::update_endpoint::UpdateEndpointInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct UpdateEndpointInputBuilder {
pub(crate) endpoint_name: ::std::option::Option<::std::string::String>,
pub(crate) endpoint_config_name: ::std::option::Option<::std::string::String>,
pub(crate) retain_all_variant_properties: ::std::option::Option<bool>,
pub(crate) exclude_retained_variant_properties: ::std::option::Option<::std::vec::Vec<crate::types::VariantProperty>>,
pub(crate) deployment_config: ::std::option::Option<crate::types::DeploymentConfig>,
pub(crate) retain_deployment_config: ::std::option::Option<bool>,
}
impl UpdateEndpointInputBuilder {
/// <p>The name of the endpoint whose configuration you want to update.</p>
/// This field is required.
pub fn endpoint_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.endpoint_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the endpoint whose configuration you want to update.</p>
pub fn set_endpoint_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.endpoint_name = input;
self
}
/// <p>The name of the endpoint whose configuration you want to update.</p>
pub fn get_endpoint_name(&self) -> &::std::option::Option<::std::string::String> {
&self.endpoint_name
}
/// <p>The name of the new endpoint configuration.</p>
/// This field is required.
pub fn endpoint_config_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.endpoint_config_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the new endpoint configuration.</p>
pub fn set_endpoint_config_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.endpoint_config_name = input;
self
}
/// <p>The name of the new endpoint configuration.</p>
pub fn get_endpoint_config_name(&self) -> &::std::option::Option<::std::string::String> {
&self.endpoint_config_name
}
/// <p>When updating endpoint resources, enables or disables the retention of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">variant properties</a>, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set <code>RetainAllVariantProperties</code> to <code>true</code>. To use the variant properties specified in a new <code>EndpointConfig</code> call when updating an endpoint, set <code>RetainAllVariantProperties</code> to <code>false</code>. The default is <code>false</code>.</p>
pub fn retain_all_variant_properties(mut self, input: bool) -> Self {
self.retain_all_variant_properties = ::std::option::Option::Some(input);
self
}
/// <p>When updating endpoint resources, enables or disables the retention of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">variant properties</a>, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set <code>RetainAllVariantProperties</code> to <code>true</code>. To use the variant properties specified in a new <code>EndpointConfig</code> call when updating an endpoint, set <code>RetainAllVariantProperties</code> to <code>false</code>. The default is <code>false</code>.</p>
pub fn set_retain_all_variant_properties(mut self, input: ::std::option::Option<bool>) -> Self {
self.retain_all_variant_properties = input;
self
}
/// <p>When updating endpoint resources, enables or disables the retention of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">variant properties</a>, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set <code>RetainAllVariantProperties</code> to <code>true</code>. To use the variant properties specified in a new <code>EndpointConfig</code> call when updating an endpoint, set <code>RetainAllVariantProperties</code> to <code>false</code>. The default is <code>false</code>.</p>
pub fn get_retain_all_variant_properties(&self) -> &::std::option::Option<bool> {
&self.retain_all_variant_properties
}
/// Appends an item to `exclude_retained_variant_properties`.
///
/// To override the contents of this collection use [`set_exclude_retained_variant_properties`](Self::set_exclude_retained_variant_properties).
///
/// <p>When you are updating endpoint resources with <code>RetainAllVariantProperties</code>, whose value is set to <code>true</code>, <code>ExcludeRetainedVariantProperties</code> specifies the list of type <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">VariantProperty</a> to override with the values provided by <code>EndpointConfig</code>. If you don't specify a value for <code>ExcludeRetainedVariantProperties</code>, no variant properties are overridden. </p>
pub fn exclude_retained_variant_properties(mut self, input: crate::types::VariantProperty) -> Self {
let mut v = self.exclude_retained_variant_properties.unwrap_or_default();
v.push(input);
self.exclude_retained_variant_properties = ::std::option::Option::Some(v);
self
}
/// <p>When you are updating endpoint resources with <code>RetainAllVariantProperties</code>, whose value is set to <code>true</code>, <code>ExcludeRetainedVariantProperties</code> specifies the list of type <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">VariantProperty</a> to override with the values provided by <code>EndpointConfig</code>. If you don't specify a value for <code>ExcludeRetainedVariantProperties</code>, no variant properties are overridden. </p>
pub fn set_exclude_retained_variant_properties(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::VariantProperty>>) -> Self {
self.exclude_retained_variant_properties = input;
self
}
/// <p>When you are updating endpoint resources with <code>RetainAllVariantProperties</code>, whose value is set to <code>true</code>, <code>ExcludeRetainedVariantProperties</code> specifies the list of type <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">VariantProperty</a> to override with the values provided by <code>EndpointConfig</code>. If you don't specify a value for <code>ExcludeRetainedVariantProperties</code>, no variant properties are overridden. </p>
pub fn get_exclude_retained_variant_properties(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::VariantProperty>> {
&self.exclude_retained_variant_properties
}
/// <p>The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.</p>
pub fn deployment_config(mut self, input: crate::types::DeploymentConfig) -> Self {
self.deployment_config = ::std::option::Option::Some(input);
self
}
/// <p>The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.</p>
pub fn set_deployment_config(mut self, input: ::std::option::Option<crate::types::DeploymentConfig>) -> Self {
self.deployment_config = input;
self
}
/// <p>The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.</p>
pub fn get_deployment_config(&self) -> &::std::option::Option<crate::types::DeploymentConfig> {
&self.deployment_config
}
/// <p>Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).</p>
pub fn retain_deployment_config(mut self, input: bool) -> Self {
self.retain_deployment_config = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).</p>
pub fn set_retain_deployment_config(mut self, input: ::std::option::Option<bool>) -> Self {
self.retain_deployment_config = input;
self
}
/// <p>Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).</p>
pub fn get_retain_deployment_config(&self) -> &::std::option::Option<bool> {
&self.retain_deployment_config
}
/// Consumes the builder and constructs a [`UpdateEndpointInput`](crate::operation::update_endpoint::UpdateEndpointInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::update_endpoint::UpdateEndpointInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::update_endpoint::UpdateEndpointInput {
endpoint_name: self.endpoint_name,
endpoint_config_name: self.endpoint_config_name,
retain_all_variant_properties: self.retain_all_variant_properties,
exclude_retained_variant_properties: self.exclude_retained_variant_properties,
deployment_config: self.deployment_config,
retain_deployment_config: self.retain_deployment_config,
})
}
}