software.amazon.awssdk.services.sagemaker.model.UpdateEndpointRequest Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sagemaker.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateEndpointRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField ENDPOINT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndpointName").getter(getter(UpdateEndpointRequest::endpointName)).setter(setter(Builder::endpointName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointName").build()).build();
private static final SdkField ENDPOINT_CONFIG_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndpointConfigName").getter(getter(UpdateEndpointRequest::endpointConfigName))
.setter(setter(Builder::endpointConfigName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointConfigName").build())
.build();
private static final SdkField RETAIN_ALL_VARIANT_PROPERTIES_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("RetainAllVariantProperties")
.getter(getter(UpdateEndpointRequest::retainAllVariantProperties))
.setter(setter(Builder::retainAllVariantProperties))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RetainAllVariantProperties").build())
.build();
private static final SdkField> EXCLUDE_RETAINED_VARIANT_PROPERTIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ExcludeRetainedVariantProperties")
.getter(getter(UpdateEndpointRequest::excludeRetainedVariantProperties))
.setter(setter(Builder::excludeRetainedVariantProperties))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExcludeRetainedVariantProperties")
.build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(VariantProperty::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField DEPLOYMENT_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DeploymentConfig")
.getter(getter(UpdateEndpointRequest::deploymentConfig)).setter(setter(Builder::deploymentConfig))
.constructor(DeploymentConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeploymentConfig").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ENDPOINT_NAME_FIELD,
ENDPOINT_CONFIG_NAME_FIELD, RETAIN_ALL_VARIANT_PROPERTIES_FIELD, EXCLUDE_RETAINED_VARIANT_PROPERTIES_FIELD,
DEPLOYMENT_CONFIG_FIELD));
private final String endpointName;
private final String endpointConfigName;
private final Boolean retainAllVariantProperties;
private final List excludeRetainedVariantProperties;
private final DeploymentConfig deploymentConfig;
private UpdateEndpointRequest(BuilderImpl builder) {
super(builder);
this.endpointName = builder.endpointName;
this.endpointConfigName = builder.endpointConfigName;
this.retainAllVariantProperties = builder.retainAllVariantProperties;
this.excludeRetainedVariantProperties = builder.excludeRetainedVariantProperties;
this.deploymentConfig = builder.deploymentConfig;
}
/**
*
* The name of the endpoint whose configuration you want to update.
*
*
* @return The name of the endpoint whose configuration you want to update.
*/
public final String endpointName() {
return endpointName;
}
/**
*
* The name of the new endpoint configuration.
*
*
* @return The name of the new endpoint configuration.
*/
public final String endpointConfigName() {
return endpointConfigName;
}
/**
*
* When updating endpoint resources, enables or disables the retention of variant properties,
* such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating
* it, set RetainAllVariantProperties to true. To use the variant properties specified in
* a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to
* false. The default is false.
*
*
* @return When updating endpoint resources, enables or disables the retention of variant
* properties, such as the instance count or the variant weight. To retain the variant properties of an
* endpoint when updating it, set RetainAllVariantProperties to true. To use the
* variant properties specified in a new EndpointConfig call when updating an endpoint, set
* RetainAllVariantProperties to false. The default is false.
*/
public final Boolean retainAllVariantProperties() {
return retainAllVariantProperties;
}
/**
* Returns true if the ExcludeRetainedVariantProperties property was specified by the sender (it may be empty), or
* false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender
* is the AWS service.
*/
public final boolean hasExcludeRetainedVariantProperties() {
return excludeRetainedVariantProperties != null && !(excludeRetainedVariantProperties instanceof SdkAutoConstructList);
}
/**
*
* When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties, whose value
* is set to true, ExcludeRetainedVariantProperties specifies the list of type
* VariantProperty to override with the values provided by EndpointConfig. If you don't specify
* a value for ExcludeAllVariantProperties, no variant properties are overridden.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasExcludeRetainedVariantProperties()} to see if a value was sent in this field.
*
*
* @return When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties,
* whose value is set to true, ExcludeRetainedVariantProperties specifies the list
* of type VariantProperty to override with the values provided by EndpointConfig. If
* you don't specify a value for ExcludeAllVariantProperties, no variant properties are
* overridden.
*/
public final List excludeRetainedVariantProperties() {
return excludeRetainedVariantProperties;
}
/**
*
* The deployment configuration for the endpoint to be updated.
*
*
* @return The deployment configuration for the endpoint to be updated.
*/
public final DeploymentConfig deploymentConfig() {
return deploymentConfig;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(endpointName());
hashCode = 31 * hashCode + Objects.hashCode(endpointConfigName());
hashCode = 31 * hashCode + Objects.hashCode(retainAllVariantProperties());
hashCode = 31 * hashCode
+ Objects.hashCode(hasExcludeRetainedVariantProperties() ? excludeRetainedVariantProperties() : null);
hashCode = 31 * hashCode + Objects.hashCode(deploymentConfig());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UpdateEndpointRequest)) {
return false;
}
UpdateEndpointRequest other = (UpdateEndpointRequest) obj;
return Objects.equals(endpointName(), other.endpointName())
&& Objects.equals(endpointConfigName(), other.endpointConfigName())
&& Objects.equals(retainAllVariantProperties(), other.retainAllVariantProperties())
&& hasExcludeRetainedVariantProperties() == other.hasExcludeRetainedVariantProperties()
&& Objects.equals(excludeRetainedVariantProperties(), other.excludeRetainedVariantProperties())
&& Objects.equals(deploymentConfig(), other.deploymentConfig());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString
.builder("UpdateEndpointRequest")
.add("EndpointName", endpointName())
.add("EndpointConfigName", endpointConfigName())
.add("RetainAllVariantProperties", retainAllVariantProperties())
.add("ExcludeRetainedVariantProperties",
hasExcludeRetainedVariantProperties() ? excludeRetainedVariantProperties() : null)
.add("DeploymentConfig", deploymentConfig()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "EndpointName":
return Optional.ofNullable(clazz.cast(endpointName()));
case "EndpointConfigName":
return Optional.ofNullable(clazz.cast(endpointConfigName()));
case "RetainAllVariantProperties":
return Optional.ofNullable(clazz.cast(retainAllVariantProperties()));
case "ExcludeRetainedVariantProperties":
return Optional.ofNullable(clazz.cast(excludeRetainedVariantProperties()));
case "DeploymentConfig":
return Optional.ofNullable(clazz.cast(deploymentConfig()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateEndpointRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the endpoint whose configuration you want to update.
*
*
* @param endpointName
* The name of the endpoint whose configuration you want to update.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endpointName(String endpointName);
/**
*
* The name of the new endpoint configuration.
*
*
* @param endpointConfigName
* The name of the new endpoint configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endpointConfigName(String endpointConfigName);
/**
*
* When updating endpoint resources, enables or disables the retention of variant
* properties, such as the instance count or the variant weight. To retain the variant properties of an
* endpoint when updating it, set RetainAllVariantProperties to true. To use the
* variant properties specified in a new EndpointConfig call when updating an endpoint, set
* RetainAllVariantProperties to false. The default is false.
*
*
* @param retainAllVariantProperties
* When updating endpoint resources, enables or disables the retention of variant
* properties, such as the instance count or the variant weight. To retain the variant properties of
* an endpoint when updating it, set RetainAllVariantProperties to true. To use
* the variant properties specified in a new EndpointConfig call when updating an endpoint,
* set RetainAllVariantProperties to false. The default is false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder retainAllVariantProperties(Boolean retainAllVariantProperties);
/**
*
* When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties, whose
* value is set to true, ExcludeRetainedVariantProperties specifies the list of type
* VariantProperty to override with the values provided by EndpointConfig. If you don't
* specify a value for ExcludeAllVariantProperties, no variant properties are overridden.
*
*
* @param excludeRetainedVariantProperties
* When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties,
* whose value is set to true, ExcludeRetainedVariantProperties specifies the
* list of type VariantProperty to override with the values provided by
* EndpointConfig. If you don't specify a value for ExcludeAllVariantProperties
* , no variant properties are overridden.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder excludeRetainedVariantProperties(Collection excludeRetainedVariantProperties);
/**
*
* When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties, whose
* value is set to true, ExcludeRetainedVariantProperties specifies the list of type
* VariantProperty to override with the values provided by EndpointConfig. If you don't
* specify a value for ExcludeAllVariantProperties, no variant properties are overridden.
*
*
* @param excludeRetainedVariantProperties
* When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties,
* whose value is set to true, ExcludeRetainedVariantProperties specifies the
* list of type VariantProperty to override with the values provided by
* EndpointConfig. If you don't specify a value for ExcludeAllVariantProperties
* , no variant properties are overridden.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder excludeRetainedVariantProperties(VariantProperty... excludeRetainedVariantProperties);
/**
*
* When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties, whose
* value is set to true, ExcludeRetainedVariantProperties specifies the list of type
* VariantProperty to override with the values provided by EndpointConfig. If you don't
* specify a value for ExcludeAllVariantProperties, no variant properties are overridden.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need
* to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #excludeRetainedVariantProperties(List)}.
*
* @param excludeRetainedVariantProperties
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #excludeRetainedVariantProperties(List)
*/
Builder excludeRetainedVariantProperties(Consumer... excludeRetainedVariantProperties);
/**
*
* The deployment configuration for the endpoint to be updated.
*
*
* @param deploymentConfig
* The deployment configuration for the endpoint to be updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deploymentConfig(DeploymentConfig deploymentConfig);
/**
*
* The deployment configuration for the endpoint to be updated.
*
* This is a convenience that creates an instance of the {@link DeploymentConfig.Builder} avoiding the need to
* create one manually via {@link DeploymentConfig#builder()}.
*
* When the {@link Consumer} completes, {@link DeploymentConfig.Builder#build()} is called immediately and its
* result is passed to {@link #deploymentConfig(DeploymentConfig)}.
*
* @param deploymentConfig
* a consumer that will call methods on {@link DeploymentConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #deploymentConfig(DeploymentConfig)
*/
default Builder deploymentConfig(Consumer deploymentConfig) {
return deploymentConfig(DeploymentConfig.builder().applyMutation(deploymentConfig).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String endpointName;
private String endpointConfigName;
private Boolean retainAllVariantProperties;
private List excludeRetainedVariantProperties = DefaultSdkAutoConstructList.getInstance();
private DeploymentConfig deploymentConfig;
private BuilderImpl() {
}
private BuilderImpl(UpdateEndpointRequest model) {
super(model);
endpointName(model.endpointName);
endpointConfigName(model.endpointConfigName);
retainAllVariantProperties(model.retainAllVariantProperties);
excludeRetainedVariantProperties(model.excludeRetainedVariantProperties);
deploymentConfig(model.deploymentConfig);
}
public final String getEndpointName() {
return endpointName;
}
@Override
public final Builder endpointName(String endpointName) {
this.endpointName = endpointName;
return this;
}
public final void setEndpointName(String endpointName) {
this.endpointName = endpointName;
}
public final String getEndpointConfigName() {
return endpointConfigName;
}
@Override
public final Builder endpointConfigName(String endpointConfigName) {
this.endpointConfigName = endpointConfigName;
return this;
}
public final void setEndpointConfigName(String endpointConfigName) {
this.endpointConfigName = endpointConfigName;
}
public final Boolean getRetainAllVariantProperties() {
return retainAllVariantProperties;
}
@Override
public final Builder retainAllVariantProperties(Boolean retainAllVariantProperties) {
this.retainAllVariantProperties = retainAllVariantProperties;
return this;
}
public final void setRetainAllVariantProperties(Boolean retainAllVariantProperties) {
this.retainAllVariantProperties = retainAllVariantProperties;
}
public final List getExcludeRetainedVariantProperties() {
List result = VariantPropertyListCopier.copyToBuilder(this.excludeRetainedVariantProperties);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
@Override
public final Builder excludeRetainedVariantProperties(Collection excludeRetainedVariantProperties) {
this.excludeRetainedVariantProperties = VariantPropertyListCopier.copy(excludeRetainedVariantProperties);
return this;
}
@Override
@SafeVarargs
public final Builder excludeRetainedVariantProperties(VariantProperty... excludeRetainedVariantProperties) {
excludeRetainedVariantProperties(Arrays.asList(excludeRetainedVariantProperties));
return this;
}
@Override
@SafeVarargs
public final Builder excludeRetainedVariantProperties(
Consumer... excludeRetainedVariantProperties) {
excludeRetainedVariantProperties(Stream.of(excludeRetainedVariantProperties)
.map(c -> VariantProperty.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setExcludeRetainedVariantProperties(
Collection excludeRetainedVariantProperties) {
this.excludeRetainedVariantProperties = VariantPropertyListCopier.copyFromBuilder(excludeRetainedVariantProperties);
}
public final DeploymentConfig.Builder getDeploymentConfig() {
return deploymentConfig != null ? deploymentConfig.toBuilder() : null;
}
@Override
public final Builder deploymentConfig(DeploymentConfig deploymentConfig) {
this.deploymentConfig = deploymentConfig;
return this;
}
public final void setDeploymentConfig(DeploymentConfig.BuilderImpl deploymentConfig) {
this.deploymentConfig = deploymentConfig != null ? deploymentConfig.build() : null;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public UpdateEndpointRequest build() {
return new UpdateEndpointRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy