software.amazon.awssdk.services.sagemaker.model.DescribeEndpointResponse 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.time.Instant;
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.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 DescribeEndpointResponse extends SageMakerResponse implements
ToCopyableBuilder {
private static final SdkField ENDPOINT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeEndpointResponse::endpointName)).setter(setter(Builder::endpointName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointName").build()).build();
private static final SdkField ENDPOINT_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeEndpointResponse::endpointArn)).setter(setter(Builder::endpointArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointArn").build()).build();
private static final SdkField ENDPOINT_CONFIG_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeEndpointResponse::endpointConfigName)).setter(setter(Builder::endpointConfigName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointConfigName").build())
.build();
private static final SdkField> PRODUCTION_VARIANTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(DescribeEndpointResponse::productionVariants))
.setter(setter(Builder::productionVariants))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProductionVariants").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ProductionVariantSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField DATA_CAPTURE_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.getter(getter(DescribeEndpointResponse::dataCaptureConfig)).setter(setter(Builder::dataCaptureConfig))
.constructor(DataCaptureConfigSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataCaptureConfig").build()).build();
private static final SdkField ENDPOINT_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeEndpointResponse::endpointStatusAsString)).setter(setter(Builder::endpointStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointStatus").build()).build();
private static final SdkField FAILURE_REASON_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeEndpointResponse::failureReason)).setter(setter(Builder::failureReason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FailureReason").build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.getter(getter(DescribeEndpointResponse::creationTime)).setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTime").build()).build();
private static final SdkField LAST_MODIFIED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.getter(getter(DescribeEndpointResponse::lastModifiedTime)).setter(setter(Builder::lastModifiedTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedTime").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ENDPOINT_NAME_FIELD,
ENDPOINT_ARN_FIELD, ENDPOINT_CONFIG_NAME_FIELD, PRODUCTION_VARIANTS_FIELD, DATA_CAPTURE_CONFIG_FIELD,
ENDPOINT_STATUS_FIELD, FAILURE_REASON_FIELD, CREATION_TIME_FIELD, LAST_MODIFIED_TIME_FIELD));
private final String endpointName;
private final String endpointArn;
private final String endpointConfigName;
private final List productionVariants;
private final DataCaptureConfigSummary dataCaptureConfig;
private final String endpointStatus;
private final String failureReason;
private final Instant creationTime;
private final Instant lastModifiedTime;
private DescribeEndpointResponse(BuilderImpl builder) {
super(builder);
this.endpointName = builder.endpointName;
this.endpointArn = builder.endpointArn;
this.endpointConfigName = builder.endpointConfigName;
this.productionVariants = builder.productionVariants;
this.dataCaptureConfig = builder.dataCaptureConfig;
this.endpointStatus = builder.endpointStatus;
this.failureReason = builder.failureReason;
this.creationTime = builder.creationTime;
this.lastModifiedTime = builder.lastModifiedTime;
}
/**
*
* Name of the endpoint.
*
*
* @return Name of the endpoint.
*/
public String endpointName() {
return endpointName;
}
/**
*
* The Amazon Resource Name (ARN) of the endpoint.
*
*
* @return The Amazon Resource Name (ARN) of the endpoint.
*/
public String endpointArn() {
return endpointArn;
}
/**
*
* The name of the endpoint configuration associated with this endpoint.
*
*
* @return The name of the endpoint configuration associated with this endpoint.
*/
public String endpointConfigName() {
return endpointConfigName;
}
/**
* Returns true if the ProductionVariants 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 boolean hasProductionVariants() {
return productionVariants != null && !(productionVariants instanceof SdkAutoConstructList);
}
/**
*
* An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasProductionVariants()} to see if a value was sent in this field.
*
*
* @return An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
*/
public List productionVariants() {
return productionVariants;
}
/**
* Returns the value of the DataCaptureConfig property for this object.
*
* @return The value of the DataCaptureConfig property for this object.
*/
public DataCaptureConfigSummary dataCaptureConfig() {
return dataCaptureConfig;
}
/**
*
* The status of the endpoint.
*
*
* -
*
* OutOfService: Endpoint is not available to take incoming requests.
*
*
* -
*
* Creating: CreateEndpoint is executing.
*
*
* -
*
* Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
*
*
* -
*
* SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled
* until it has completed. This maintenance operation does not change any customer-specified values such as VPC
* config, KMS encryption, model, instance type, or instance count.
*
*
* -
*
* RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process
* of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an
* InService status. This transitional status only applies to an endpoint that has autoscaling enabled
* and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call
* or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.
*
*
* -
*
* InService: Endpoint is available to process incoming requests.
*
*
* -
*
* Deleting: DeleteEndpoint is executing.
*
*
* -
*
* Failed: Endpoint could not be created, updated, or re-scaled. Use
* DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only
* operation that can be performed on a failed endpoint.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #endpointStatus}
* will return {@link EndpointStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #endpointStatusAsString}.
*
*
* @return The status of the endpoint.
*
* -
*
* OutOfService: Endpoint is not available to take incoming requests.
*
*
* -
*
* Creating: CreateEndpoint is executing.
*
*
* -
*
* Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
*
*
* -
*
* SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or
* re-scaled until it has completed. This maintenance operation does not change any customer-specified
* values such as VPC config, KMS encryption, model, instance type, or instance count.
*
*
* -
*
* RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the
* process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to
* an InService status. This transitional status only applies to an endpoint that has
* autoscaling enabled and is undergoing variant weight or capacity changes as part of an
* UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities
* operation is called explicitly.
*
*
* -
*
* InService: Endpoint is available to process incoming requests.
*
*
* -
*
* Deleting: DeleteEndpoint is executing.
*
*
* -
*
* Failed: Endpoint could not be created, updated, or re-scaled. Use
* DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is
* the only operation that can be performed on a failed endpoint.
*
*
* @see EndpointStatus
*/
public EndpointStatus endpointStatus() {
return EndpointStatus.fromValue(endpointStatus);
}
/**
*
* The status of the endpoint.
*
*
* -
*
* OutOfService: Endpoint is not available to take incoming requests.
*
*
* -
*
* Creating: CreateEndpoint is executing.
*
*
* -
*
* Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
*
*
* -
*
* SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled
* until it has completed. This maintenance operation does not change any customer-specified values such as VPC
* config, KMS encryption, model, instance type, or instance count.
*
*
* -
*
* RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process
* of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an
* InService status. This transitional status only applies to an endpoint that has autoscaling enabled
* and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call
* or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.
*
*
* -
*
* InService: Endpoint is available to process incoming requests.
*
*
* -
*
* Deleting: DeleteEndpoint is executing.
*
*
* -
*
* Failed: Endpoint could not be created, updated, or re-scaled. Use
* DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only
* operation that can be performed on a failed endpoint.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #endpointStatus}
* will return {@link EndpointStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #endpointStatusAsString}.
*
*
* @return The status of the endpoint.
*
* -
*
* OutOfService: Endpoint is not available to take incoming requests.
*
*
* -
*
* Creating: CreateEndpoint is executing.
*
*
* -
*
* Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
*
*
* -
*
* SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or
* re-scaled until it has completed. This maintenance operation does not change any customer-specified
* values such as VPC config, KMS encryption, model, instance type, or instance count.
*
*
* -
*
* RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the
* process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to
* an InService status. This transitional status only applies to an endpoint that has
* autoscaling enabled and is undergoing variant weight or capacity changes as part of an
* UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities
* operation is called explicitly.
*
*
* -
*
* InService: Endpoint is available to process incoming requests.
*
*
* -
*
* Deleting: DeleteEndpoint is executing.
*
*
* -
*
* Failed: Endpoint could not be created, updated, or re-scaled. Use
* DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is
* the only operation that can be performed on a failed endpoint.
*
*
* @see EndpointStatus
*/
public String endpointStatusAsString() {
return endpointStatus;
}
/**
*
* If the status of the endpoint is Failed, the reason why it failed.
*
*
* @return If the status of the endpoint is Failed, the reason why it failed.
*/
public String failureReason() {
return failureReason;
}
/**
*
* A timestamp that shows when the endpoint was created.
*
*
* @return A timestamp that shows when the endpoint was created.
*/
public Instant creationTime() {
return creationTime;
}
/**
*
* A timestamp that shows when the endpoint was last modified.
*
*
* @return A timestamp that shows when the endpoint was last modified.
*/
public Instant lastModifiedTime() {
return lastModifiedTime;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(endpointName());
hashCode = 31 * hashCode + Objects.hashCode(endpointArn());
hashCode = 31 * hashCode + Objects.hashCode(endpointConfigName());
hashCode = 31 * hashCode + Objects.hashCode(productionVariants());
hashCode = 31 * hashCode + Objects.hashCode(dataCaptureConfig());
hashCode = 31 * hashCode + Objects.hashCode(endpointStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(failureReason());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedTime());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeEndpointResponse)) {
return false;
}
DescribeEndpointResponse other = (DescribeEndpointResponse) obj;
return Objects.equals(endpointName(), other.endpointName()) && Objects.equals(endpointArn(), other.endpointArn())
&& Objects.equals(endpointConfigName(), other.endpointConfigName())
&& Objects.equals(productionVariants(), other.productionVariants())
&& Objects.equals(dataCaptureConfig(), other.dataCaptureConfig())
&& Objects.equals(endpointStatusAsString(), other.endpointStatusAsString())
&& Objects.equals(failureReason(), other.failureReason()) && Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(lastModifiedTime(), other.lastModifiedTime());
}
/**
* 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 String toString() {
return ToString.builder("DescribeEndpointResponse").add("EndpointName", endpointName()).add("EndpointArn", endpointArn())
.add("EndpointConfigName", endpointConfigName()).add("ProductionVariants", productionVariants())
.add("DataCaptureConfig", dataCaptureConfig()).add("EndpointStatus", endpointStatusAsString())
.add("FailureReason", failureReason()).add("CreationTime", creationTime())
.add("LastModifiedTime", lastModifiedTime()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "EndpointName":
return Optional.ofNullable(clazz.cast(endpointName()));
case "EndpointArn":
return Optional.ofNullable(clazz.cast(endpointArn()));
case "EndpointConfigName":
return Optional.ofNullable(clazz.cast(endpointConfigName()));
case "ProductionVariants":
return Optional.ofNullable(clazz.cast(productionVariants()));
case "DataCaptureConfig":
return Optional.ofNullable(clazz.cast(dataCaptureConfig()));
case "EndpointStatus":
return Optional.ofNullable(clazz.cast(endpointStatusAsString()));
case "FailureReason":
return Optional.ofNullable(clazz.cast(failureReason()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "LastModifiedTime":
return Optional.ofNullable(clazz.cast(lastModifiedTime()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeEndpointResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* Name of the endpoint.
*
*
* @param endpointName
* Name of the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endpointName(String endpointName);
/**
*
* The Amazon Resource Name (ARN) of the endpoint.
*
*
* @param endpointArn
* The Amazon Resource Name (ARN) of the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endpointArn(String endpointArn);
/**
*
* The name of the endpoint configuration associated with this endpoint.
*
*
* @param endpointConfigName
* The name of the endpoint configuration associated with this endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endpointConfigName(String endpointConfigName);
/**
*
* An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
*
*
* @param productionVariants
* An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder productionVariants(Collection productionVariants);
/**
*
* An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
*
*
* @param productionVariants
* An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder productionVariants(ProductionVariantSummary... productionVariants);
/**
*
* An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
*
* 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 #productionVariants(List)}.
*
* @param productionVariants
* 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 #productionVariants(List)
*/
Builder productionVariants(Consumer... productionVariants);
/**
* Sets the value of the DataCaptureConfig property for this object.
*
* @param dataCaptureConfig
* The new value for the DataCaptureConfig property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataCaptureConfig(DataCaptureConfigSummary dataCaptureConfig);
/**
* Sets the value of the DataCaptureConfig property for this object.
*
* This is a convenience that creates an instance of the {@link DataCaptureConfigSummary.Builder} avoiding the
* need to create one manually via {@link DataCaptureConfigSummary#builder()}.
*
* When the {@link Consumer} completes, {@link DataCaptureConfigSummary.Builder#build()} is called immediately
* and its result is passed to {@link #dataCaptureConfig(DataCaptureConfigSummary)}.
*
* @param dataCaptureConfig
* a consumer that will call methods on {@link DataCaptureConfigSummary.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dataCaptureConfig(DataCaptureConfigSummary)
*/
default Builder dataCaptureConfig(Consumer dataCaptureConfig) {
return dataCaptureConfig(DataCaptureConfigSummary.builder().applyMutation(dataCaptureConfig).build());
}
/**
*
* The status of the endpoint.
*
*
* -
*
* OutOfService: Endpoint is not available to take incoming requests.
*
*
* -
*
* Creating: CreateEndpoint is executing.
*
*
* -
*
* Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
*
*
* -
*
* SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled
* until it has completed. This maintenance operation does not change any customer-specified values such as VPC
* config, KMS encryption, model, instance type, or instance count.
*
*
* -
*
* RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the
* process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an
* InService status. This transitional status only applies to an endpoint that has autoscaling
* enabled and is undergoing variant weight or capacity changes as part of an
* UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities
* operation is called explicitly.
*
*
* -
*
* InService: Endpoint is available to process incoming requests.
*
*
* -
*
* Deleting: DeleteEndpoint is executing.
*
*
* -
*
* Failed: Endpoint could not be created, updated, or re-scaled. Use
* DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the
* only operation that can be performed on a failed endpoint.
*
*
*
*
* @param endpointStatus
* The status of the endpoint.
*
* -
*
* OutOfService: Endpoint is not available to take incoming requests.
*
*
* -
*
* Creating: CreateEndpoint is executing.
*
*
* -
*
* Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is
* executing.
*
*
* -
*
* SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or
* re-scaled until it has completed. This maintenance operation does not change any customer-specified
* values such as VPC config, KMS encryption, model, instance type, or instance count.
*
*
* -
*
* RollingBack: Endpoint fails to scale up or down or change its variant weight and is in
* the process of rolling back to its previous configuration. Once the rollback completes, endpoint
* returns to an InService status. This transitional status only applies to an endpoint that
* has autoscaling enabled and is undergoing variant weight or capacity changes as part of an
* UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities
* operation is called explicitly.
*
*
* -
*
* InService: Endpoint is available to process incoming requests.
*
*
* -
*
* Deleting: DeleteEndpoint is executing.
*
*
* -
*
* Failed: Endpoint could not be created, updated, or re-scaled. Use
* DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint
* is the only operation that can be performed on a failed endpoint.
*
*
* @see EndpointStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see EndpointStatus
*/
Builder endpointStatus(String endpointStatus);
/**
*
* The status of the endpoint.
*
*
* -
*
* OutOfService: Endpoint is not available to take incoming requests.
*
*
* -
*
* Creating: CreateEndpoint is executing.
*
*
* -
*
* Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
*
*
* -
*
* SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled
* until it has completed. This maintenance operation does not change any customer-specified values such as VPC
* config, KMS encryption, model, instance type, or instance count.
*
*
* -
*
* RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the
* process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an
* InService status. This transitional status only applies to an endpoint that has autoscaling
* enabled and is undergoing variant weight or capacity changes as part of an
* UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities
* operation is called explicitly.
*
*
* -
*
* InService: Endpoint is available to process incoming requests.
*
*
* -
*
* Deleting: DeleteEndpoint is executing.
*
*
* -
*
* Failed: Endpoint could not be created, updated, or re-scaled. Use
* DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the
* only operation that can be performed on a failed endpoint.
*
*
*
*
* @param endpointStatus
* The status of the endpoint.
*
* -
*
* OutOfService: Endpoint is not available to take incoming requests.
*
*
* -
*
* Creating: CreateEndpoint is executing.
*
*
* -
*
* Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is
* executing.
*
*
* -
*
* SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or
* re-scaled until it has completed. This maintenance operation does not change any customer-specified
* values such as VPC config, KMS encryption, model, instance type, or instance count.
*
*
* -
*
* RollingBack: Endpoint fails to scale up or down or change its variant weight and is in
* the process of rolling back to its previous configuration. Once the rollback completes, endpoint
* returns to an InService status. This transitional status only applies to an endpoint that
* has autoscaling enabled and is undergoing variant weight or capacity changes as part of an
* UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities
* operation is called explicitly.
*
*
* -
*
* InService: Endpoint is available to process incoming requests.
*
*
* -
*
* Deleting: DeleteEndpoint is executing.
*
*
* -
*
* Failed: Endpoint could not be created, updated, or re-scaled. Use
* DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint
* is the only operation that can be performed on a failed endpoint.
*
*
* @see EndpointStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see EndpointStatus
*/
Builder endpointStatus(EndpointStatus endpointStatus);
/**
*
* If the status of the endpoint is Failed, the reason why it failed.
*
*
* @param failureReason
* If the status of the endpoint is Failed, the reason why it failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failureReason(String failureReason);
/**
*
* A timestamp that shows when the endpoint was created.
*
*
* @param creationTime
* A timestamp that shows when the endpoint was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
*
* A timestamp that shows when the endpoint was last modified.
*
*
* @param lastModifiedTime
* A timestamp that shows when the endpoint was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedTime(Instant lastModifiedTime);
}
static final class BuilderImpl extends SageMakerResponse.BuilderImpl implements Builder {
private String endpointName;
private String endpointArn;
private String endpointConfigName;
private List productionVariants = DefaultSdkAutoConstructList.getInstance();
private DataCaptureConfigSummary dataCaptureConfig;
private String endpointStatus;
private String failureReason;
private Instant creationTime;
private Instant lastModifiedTime;
private BuilderImpl() {
}
private BuilderImpl(DescribeEndpointResponse model) {
super(model);
endpointName(model.endpointName);
endpointArn(model.endpointArn);
endpointConfigName(model.endpointConfigName);
productionVariants(model.productionVariants);
dataCaptureConfig(model.dataCaptureConfig);
endpointStatus(model.endpointStatus);
failureReason(model.failureReason);
creationTime(model.creationTime);
lastModifiedTime(model.lastModifiedTime);
}
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 getEndpointArn() {
return endpointArn;
}
@Override
public final Builder endpointArn(String endpointArn) {
this.endpointArn = endpointArn;
return this;
}
public final void setEndpointArn(String endpointArn) {
this.endpointArn = endpointArn;
}
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 Collection getProductionVariants() {
return productionVariants != null ? productionVariants.stream().map(ProductionVariantSummary::toBuilder)
.collect(Collectors.toList()) : null;
}
@Override
public final Builder productionVariants(Collection productionVariants) {
this.productionVariants = ProductionVariantSummaryListCopier.copy(productionVariants);
return this;
}
@Override
@SafeVarargs
public final Builder productionVariants(ProductionVariantSummary... productionVariants) {
productionVariants(Arrays.asList(productionVariants));
return this;
}
@Override
@SafeVarargs
public final Builder productionVariants(Consumer... productionVariants) {
productionVariants(Stream.of(productionVariants)
.map(c -> ProductionVariantSummary.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setProductionVariants(Collection productionVariants) {
this.productionVariants = ProductionVariantSummaryListCopier.copyFromBuilder(productionVariants);
}
public final DataCaptureConfigSummary.Builder getDataCaptureConfig() {
return dataCaptureConfig != null ? dataCaptureConfig.toBuilder() : null;
}
@Override
public final Builder dataCaptureConfig(DataCaptureConfigSummary dataCaptureConfig) {
this.dataCaptureConfig = dataCaptureConfig;
return this;
}
public final void setDataCaptureConfig(DataCaptureConfigSummary.BuilderImpl dataCaptureConfig) {
this.dataCaptureConfig = dataCaptureConfig != null ? dataCaptureConfig.build() : null;
}
public final String getEndpointStatus() {
return endpointStatus;
}
@Override
public final Builder endpointStatus(String endpointStatus) {
this.endpointStatus = endpointStatus;
return this;
}
@Override
public final Builder endpointStatus(EndpointStatus endpointStatus) {
this.endpointStatus(endpointStatus == null ? null : endpointStatus.toString());
return this;
}
public final void setEndpointStatus(String endpointStatus) {
this.endpointStatus = endpointStatus;
}
public final String getFailureReason() {
return failureReason;
}
@Override
public final Builder failureReason(String failureReason) {
this.failureReason = failureReason;
return this;
}
public final void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
public final Instant getCreationTime() {
return creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
public final Instant getLastModifiedTime() {
return lastModifiedTime;
}
@Override
public final Builder lastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
return this;
}
public final void setLastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
@Override
public DescribeEndpointResponse build() {
return new DescribeEndpointResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}