software.amazon.awssdk.services.sagemaker.model.EndpointSummary 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.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
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.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Provides summary information for an endpoint.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EndpointSummary implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ENDPOINT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndpointName").getter(getter(EndpointSummary::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)
.memberName("EndpointArn").getter(getter(EndpointSummary::endpointArn)).setter(setter(Builder::endpointArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointArn").build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(EndpointSummary::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)
.memberName("LastModifiedTime").getter(getter(EndpointSummary::lastModifiedTime))
.setter(setter(Builder::lastModifiedTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedTime").build()).build();
private static final SdkField ENDPOINT_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndpointStatus").getter(getter(EndpointSummary::endpointStatusAsString))
.setter(setter(Builder::endpointStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointStatus").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ENDPOINT_NAME_FIELD,
ENDPOINT_ARN_FIELD, CREATION_TIME_FIELD, LAST_MODIFIED_TIME_FIELD, ENDPOINT_STATUS_FIELD));
private static final long serialVersionUID = 1L;
private final String endpointName;
private final String endpointArn;
private final Instant creationTime;
private final Instant lastModifiedTime;
private final String endpointStatus;
private EndpointSummary(BuilderImpl builder) {
this.endpointName = builder.endpointName;
this.endpointArn = builder.endpointArn;
this.creationTime = builder.creationTime;
this.lastModifiedTime = builder.lastModifiedTime;
this.endpointStatus = builder.endpointStatus;
}
/**
*
* The name of the endpoint.
*
*
* @return The name of the endpoint.
*/
public final String endpointName() {
return endpointName;
}
/**
*
* The Amazon Resource Name (ARN) of the endpoint.
*
*
* @return The Amazon Resource Name (ARN) of the endpoint.
*/
public final String endpointArn() {
return endpointArn;
}
/**
*
* A timestamp that shows when the endpoint was created.
*
*
* @return A timestamp that shows when the endpoint was created.
*/
public final 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 final Instant lastModifiedTime() {
return lastModifiedTime;
}
/**
*
* 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.
*
*
*
*
* To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.
*
*
* 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.
*
*
*
*
* To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals
* filter.
* @see EndpointStatus
*/
public final 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.
*
*
*
*
* To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.
*
*
* 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.
*
*
*
*
* To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals
* filter.
* @see EndpointStatus
*/
public final String endpointStatusAsString() {
return endpointStatus;
}
@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 + Objects.hashCode(endpointName());
hashCode = 31 * hashCode + Objects.hashCode(endpointArn());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedTime());
hashCode = 31 * hashCode + Objects.hashCode(endpointStatusAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EndpointSummary)) {
return false;
}
EndpointSummary other = (EndpointSummary) obj;
return Objects.equals(endpointName(), other.endpointName()) && Objects.equals(endpointArn(), other.endpointArn())
&& Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(lastModifiedTime(), other.lastModifiedTime())
&& Objects.equals(endpointStatusAsString(), other.endpointStatusAsString());
}
/**
* 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("EndpointSummary").add("EndpointName", endpointName()).add("EndpointArn", endpointArn())
.add("CreationTime", creationTime()).add("LastModifiedTime", lastModifiedTime())
.add("EndpointStatus", endpointStatusAsString()).build();
}
public final 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 "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "LastModifiedTime":
return Optional.ofNullable(clazz.cast(lastModifiedTime()));
case "EndpointStatus":
return Optional.ofNullable(clazz.cast(endpointStatusAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((EndpointSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the endpoint.
*
*
* @param endpointName
* The 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);
/**
*
* 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);
/**
*
* 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.
*
*
*
*
* To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.
*
*
* @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.
*
*
*
*
* To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals
* filter.
* @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.
*
*
*
*
* To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.
*
*
* @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.
*
*
*
*
* To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals
* filter.
* @see EndpointStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see EndpointStatus
*/
Builder endpointStatus(EndpointStatus endpointStatus);
}
static final class BuilderImpl implements Builder {
private String endpointName;
private String endpointArn;
private Instant creationTime;
private Instant lastModifiedTime;
private String endpointStatus;
private BuilderImpl() {
}
private BuilderImpl(EndpointSummary model) {
endpointName(model.endpointName);
endpointArn(model.endpointArn);
creationTime(model.creationTime);
lastModifiedTime(model.lastModifiedTime);
endpointStatus(model.endpointStatus);
}
public final String getEndpointName() {
return endpointName;
}
public final void setEndpointName(String endpointName) {
this.endpointName = endpointName;
}
@Override
public final Builder endpointName(String endpointName) {
this.endpointName = endpointName;
return this;
}
public final String getEndpointArn() {
return endpointArn;
}
public final void setEndpointArn(String endpointArn) {
this.endpointArn = endpointArn;
}
@Override
public final Builder endpointArn(String endpointArn) {
this.endpointArn = endpointArn;
return this;
}
public final Instant getCreationTime() {
return creationTime;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
public final Instant getLastModifiedTime() {
return lastModifiedTime;
}
public final void setLastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
@Override
public final Builder lastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
return this;
}
public final String getEndpointStatus() {
return endpointStatus;
}
public final void setEndpointStatus(String endpointStatus) {
this.endpointStatus = 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;
}
@Override
public EndpointSummary build() {
return new EndpointSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}