/*
* Copyright 2018-2023 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeEndpointResult extends com.amazonaws.AmazonWebServiceResult
* Name of the endpoint.
*
* The Amazon Resource Name (ARN) of the endpoint.
*
* The name of the endpoint configuration associated with this endpoint.
*
* An array of
* ProductionVariantSummary objects, one for each model hosted behind this endpoint.
*
* The status of the endpoint.
*
*
*
*
*
*
*
*
*
* If the status of the endpoint is
* A timestamp that shows when the endpoint was created.
*
* A timestamp that shows when the endpoint was last modified.
*
* The most recent deployment configuration for the endpoint.
*
* Returns the description of an endpoint configuration created using the
*
* Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or
* updating with a new endpoint configuration.
*
* The configuration parameters for an explainer.
*
* An array of
* ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode
* with production traffic replicated from the model specified on
* Name of the endpoint.
*
* Name of the endpoint.
*
* Name of the endpoint.
*
* The Amazon Resource Name (ARN) of the endpoint.
*
* The Amazon Resource Name (ARN) of the endpoint.
*
* The Amazon Resource Name (ARN) of the endpoint.
*
* The name of the endpoint configuration associated with this endpoint.
*
* The name of the endpoint configuration associated with this endpoint.
*
* The name of the endpoint configuration associated with this endpoint.
*
* An array of
* ProductionVariantSummary objects, one for each model hosted behind this endpoint.
*
* An array of
* ProductionVariantSummary objects, one for each model hosted behind this endpoint.
*
* An array of
* ProductionVariantSummary objects, one for each model hosted behind this endpoint.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setProductionVariants(java.util.Collection)} or {@link #withProductionVariants(java.util.Collection)} if
* you want to override the existing values.
*
* An array of
* ProductionVariantSummary objects, one for each model hosted behind this endpoint.
*
* The status of the endpoint.
*
*
*
*
*
*
*
*
*
*
*/
private String endpointStatus;
/**
* 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 the FailureReason
* value returned by DescribeEndpoint
* for information about the failure. DeleteEndpoint is
* the only operation that can be performed on a failed endpoint.
* Failed
, the reason why it failed.
* CreateEndpointConfig
API.
* ProductionVariants
.
*
*
*
* @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 the FailureReason
* value returned by DescribeEndpoint
* for information about the failure. DeleteEndpoint is
* the only operation that can be performed on a failed 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 the
* FailureReason
value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
*
* 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 the FailureReason
* value returned by DescribeEndpoint
* for information about the failure. DeleteEndpoint is
* the only operation that can be performed on a failed 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 the
* FailureReason
value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
*
* 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 the FailureReason
* value returned by DescribeEndpoint
* for information about the failure. DeleteEndpoint is
* the only operation that can be performed on a failed 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 the
* FailureReason
value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
*
* 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 the FailureReason
* value returned by DescribeEndpoint
* for information about the failure. DeleteEndpoint is
* the only operation that can be performed on a failed 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 the
* FailureReason
value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
*
* If the status of the endpoint is Failed
, the reason why it failed.
*
Failed
, the reason why it failed.
*/
public void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
/**
*
* If the status of the endpoint is Failed
, the reason why it failed.
*
Failed
, the reason why it failed.
*/
public String getFailureReason() {
return this.failureReason;
}
/**
*
* If the status of the endpoint is Failed
, the reason why it failed.
*
Failed
, the reason why it failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointResult withFailureReason(String failureReason) {
setFailureReason(failureReason);
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 DescribeEndpointResult 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 DescribeEndpointResult withLastModifiedTime(java.util.Date lastModifiedTime) { setLastModifiedTime(lastModifiedTime); return this; } /** ** The most recent deployment configuration for the endpoint. *
* * @param lastDeploymentConfig * The most recent deployment configuration for the endpoint. */ public void setLastDeploymentConfig(DeploymentConfig lastDeploymentConfig) { this.lastDeploymentConfig = lastDeploymentConfig; } /** ** The most recent deployment configuration for the endpoint. *
* * @return The most recent deployment configuration for the endpoint. */ public DeploymentConfig getLastDeploymentConfig() { return this.lastDeploymentConfig; } /** ** The most recent deployment configuration for the endpoint. *
* * @param lastDeploymentConfig * The most recent deployment configuration for the endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEndpointResult withLastDeploymentConfig(DeploymentConfig lastDeploymentConfig) { setLastDeploymentConfig(lastDeploymentConfig); return this; } /** *
* Returns the description of an endpoint configuration created using the
* CreateEndpointConfig
API.
*
CreateEndpointConfig
API.
*/
public void setAsyncInferenceConfig(AsyncInferenceConfig asyncInferenceConfig) {
this.asyncInferenceConfig = asyncInferenceConfig;
}
/**
*
* Returns the description of an endpoint configuration created using the
* CreateEndpointConfig
API.
*
CreateEndpointConfig
API.
*/
public AsyncInferenceConfig getAsyncInferenceConfig() {
return this.asyncInferenceConfig;
}
/**
*
* Returns the description of an endpoint configuration created using the
* CreateEndpointConfig
API.
*
CreateEndpointConfig
API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointResult withAsyncInferenceConfig(AsyncInferenceConfig asyncInferenceConfig) {
setAsyncInferenceConfig(asyncInferenceConfig);
return this;
}
/**
* * Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or * updating with a new endpoint configuration. *
* * @param pendingDeploymentSummary * Returns the summary of an in-progress deployment. This field is only returned when the endpoint is * creating or updating with a new endpoint configuration. */ public void setPendingDeploymentSummary(PendingDeploymentSummary pendingDeploymentSummary) { this.pendingDeploymentSummary = pendingDeploymentSummary; } /** ** Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or * updating with a new endpoint configuration. *
* * @return Returns the summary of an in-progress deployment. This field is only returned when the endpoint is * creating or updating with a new endpoint configuration. */ public PendingDeploymentSummary getPendingDeploymentSummary() { return this.pendingDeploymentSummary; } /** ** Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or * updating with a new endpoint configuration. *
* * @param pendingDeploymentSummary * Returns the summary of an in-progress deployment. This field is only returned when the endpoint is * creating or updating with a new endpoint configuration. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEndpointResult withPendingDeploymentSummary(PendingDeploymentSummary pendingDeploymentSummary) { setPendingDeploymentSummary(pendingDeploymentSummary); return this; } /** ** The configuration parameters for an explainer. *
* * @param explainerConfig * The configuration parameters for an explainer. */ public void setExplainerConfig(ExplainerConfig explainerConfig) { this.explainerConfig = explainerConfig; } /** ** The configuration parameters for an explainer. *
* * @return The configuration parameters for an explainer. */ public ExplainerConfig getExplainerConfig() { return this.explainerConfig; } /** ** The configuration parameters for an explainer. *
* * @param explainerConfig * The configuration parameters for an explainer. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEndpointResult withExplainerConfig(ExplainerConfig explainerConfig) { setExplainerConfig(explainerConfig); return this; } /** *
* An array of
* ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode
* with production traffic replicated from the model specified on ProductionVariants
.
*
ProductionVariants
.
*/
public java.util.List
* An array of
* ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode
* with production traffic replicated from the model specified on ProductionVariants
.
*
ProductionVariants
.
*/
public void setShadowProductionVariants(java.util.Collection
* An array of
* ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode
* with production traffic replicated from the model specified on ProductionVariants
.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setShadowProductionVariants(java.util.Collection)} or * {@link #withShadowProductionVariants(java.util.Collection)} if you want to override the existing values. *
* * @param shadowProductionVariants * An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow * mode with production traffic replicated from the model specified onProductionVariants
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointResult withShadowProductionVariants(ProductionVariantSummary... shadowProductionVariants) {
if (this.shadowProductionVariants == null) {
setShadowProductionVariants(new java.util.ArrayList
* An array of
* ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode
* with production traffic replicated from the model specified on ProductionVariants
.
*
ProductionVariants
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointResult withShadowProductionVariants(java.util.Collection