com.amazonaws.services.sagemaker.model.EndpointSummary Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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 com.amazonaws.services.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides summary information for an endpoint.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EndpointSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the endpoint.
*
*/
private String endpointName;
/**
*
* The Amazon Resource Name (ARN) of the endpoint.
*
*/
private String endpointArn;
/**
*
* A timestamp that shows when the endpoint was created.
*
*/
private java.util.Date creationTime;
/**
*
* A timestamp that shows when the endpoint was last modified.
*
*/
private java.util.Date 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 StatusEquals filter with a call to ListEndpoints.
*
*/
private String endpointStatus;
/**
*
* The name of the endpoint.
*
*
* @param endpointName
* The name of the endpoint.
*/
public void setEndpointName(String endpointName) {
this.endpointName = endpointName;
}
/**
*
* The name of the endpoint.
*
*
* @return The name of the endpoint.
*/
public String getEndpointName() {
return this.endpointName;
}
/**
*
* 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.
*/
public EndpointSummary withEndpointName(String endpointName) {
setEndpointName(endpointName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the endpoint.
*
*
* @param endpointArn
* The Amazon Resource Name (ARN) of the endpoint.
*/
public void setEndpointArn(String endpointArn) {
this.endpointArn = endpointArn;
}
/**
*
* The Amazon Resource Name (ARN) of the endpoint.
*
*
* @return The Amazon Resource Name (ARN) of the endpoint.
*/
public String getEndpointArn() {
return this.endpointArn;
}
/**
*
* 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.
*/
public EndpointSummary withEndpointArn(String endpointArn) {
setEndpointArn(endpointArn);
return this;
}
/**
*
* A timestamp that shows when the endpoint was created.
*
*
* @param creationTime
* A timestamp that shows when the endpoint was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* A timestamp that shows when the endpoint was created.
*
*
* @return A timestamp that shows when the endpoint was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* 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.
*/
public EndpointSummary withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* A timestamp that shows when the endpoint was last modified.
*
*
* @param lastModifiedTime
* A timestamp that shows when the endpoint was last modified.
*/
public void setLastModifiedTime(java.util.Date lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
/**
*
* A timestamp that shows when the endpoint was last modified.
*
*
* @return A timestamp that shows when the endpoint was last modified.
*/
public java.util.Date getLastModifiedTime() {
return this.lastModifiedTime;
}
/**
*
* 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.
*/
public EndpointSummary withLastModifiedTime(java.util.Date lastModifiedTime) {
setLastModifiedTime(lastModifiedTime);
return this;
}
/**
*
* 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 StatusEquals filter with a call to ListEndpoints.
*
*
* @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 StatusEquals filter with a call
* to ListEndpoints.
* @see EndpointStatus
*/
public void setEndpointStatus(String endpointStatus) {
this.endpointStatus = 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 StatusEquals filter with a call to ListEndpoints.
*
*
* @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 StatusEquals filter with a call
* to ListEndpoints
* .
* @see EndpointStatus
*/
public String getEndpointStatus() {
return this.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 StatusEquals filter with a call to ListEndpoints.
*
*
* @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 StatusEquals filter with a call
* to ListEndpoints.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EndpointStatus
*/
public EndpointSummary withEndpointStatus(String endpointStatus) {
setEndpointStatus(endpointStatus);
return this;
}
/**
*
* 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 StatusEquals filter with a call to ListEndpoints.
*
*
* @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 StatusEquals filter with a call
* to ListEndpoints.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EndpointStatus
*/
public EndpointSummary withEndpointStatus(EndpointStatus endpointStatus) {
this.endpointStatus = endpointStatus.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEndpointName() != null)
sb.append("EndpointName: ").append(getEndpointName()).append(",");
if (getEndpointArn() != null)
sb.append("EndpointArn: ").append(getEndpointArn()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getLastModifiedTime() != null)
sb.append("LastModifiedTime: ").append(getLastModifiedTime()).append(",");
if (getEndpointStatus() != null)
sb.append("EndpointStatus: ").append(getEndpointStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof EndpointSummary == false)
return false;
EndpointSummary other = (EndpointSummary) obj;
if (other.getEndpointName() == null ^ this.getEndpointName() == null)
return false;
if (other.getEndpointName() != null && other.getEndpointName().equals(this.getEndpointName()) == false)
return false;
if (other.getEndpointArn() == null ^ this.getEndpointArn() == null)
return false;
if (other.getEndpointArn() != null && other.getEndpointArn().equals(this.getEndpointArn()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getLastModifiedTime() == null ^ this.getLastModifiedTime() == null)
return false;
if (other.getLastModifiedTime() != null && other.getLastModifiedTime().equals(this.getLastModifiedTime()) == false)
return false;
if (other.getEndpointStatus() == null ^ this.getEndpointStatus() == null)
return false;
if (other.getEndpointStatus() != null && other.getEndpointStatus().equals(this.getEndpointStatus()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEndpointName() == null) ? 0 : getEndpointName().hashCode());
hashCode = prime * hashCode + ((getEndpointArn() == null) ? 0 : getEndpointArn().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getLastModifiedTime() == null) ? 0 : getLastModifiedTime().hashCode());
hashCode = prime * hashCode + ((getEndpointStatus() == null) ? 0 : getEndpointStatus().hashCode());
return hashCode;
}
@Override
public EndpointSummary clone() {
try {
return (EndpointSummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.sagemaker.model.transform.EndpointSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}