EndpointSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.EndpointSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EndpointSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides summary information for an endpoint.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EndpointSummary()

Constructors
Constructor and Description
`EndpointSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EndpointSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` A timestamp that shows when the endpoint was created.
`String`	`getEndpointArn()` The Amazon Resource Name (ARN) of the endpoint.
`String`	`getEndpointName()` The name of the endpoint.
`String`	`getEndpointStatus()` The status of the endpoint.
`Date`	`getLastModifiedTime()` A timestamp that shows when the endpoint was last modified.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` A timestamp that shows when the endpoint was created.
`void`	`setEndpointArn(String endpointArn)` The Amazon Resource Name (ARN) of the endpoint.
`void`	`setEndpointName(String endpointName)` The name of the endpoint.
`void`	`setEndpointStatus(String endpointStatus)` The status of the endpoint.
`void`	`setLastModifiedTime(Date lastModifiedTime)` A timestamp that shows when the endpoint was last modified.
`String`	`toString()` Returns a string representation of this object.
`EndpointSummary`	`withCreationTime(Date creationTime)` A timestamp that shows when the endpoint was created.
`EndpointSummary`	`withEndpointArn(String endpointArn)` The Amazon Resource Name (ARN) of the endpoint.
`EndpointSummary`	`withEndpointName(String endpointName)` The name of the endpoint.
`EndpointSummary`	`withEndpointStatus(EndpointStatus endpointStatus)` The status of the endpoint.
`EndpointSummary`	`withEndpointStatus(String endpointStatus)` The status of the endpoint.
`EndpointSummary`	`withLastModifiedTime(Date lastModifiedTime)` A timestamp that shows when the endpoint was last modified.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EndpointSummary
```
public EndpointSummary()
```
- Method Detail
  - setEndpointName
```
public void setEndpointName(String endpointName)
```
    The name of the endpoint.
    
    Parameters:
    
    endpointName - The name of the endpoint.
  - getEndpointName
```
public String getEndpointName()
```
    The name of the endpoint.
    
    Returns:
    
    The name of the endpoint.
  - withEndpointName
```
public EndpointSummary withEndpointName(String endpointName)
```
    The name of the endpoint.
    
    Parameters:
    
    endpointName - The name of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointArn
```
public void setEndpointArn(String endpointArn)
```
    The Amazon Resource Name (ARN) of the endpoint.
    
    Parameters:
    
    endpointArn - The Amazon Resource Name (ARN) of the endpoint.
  - getEndpointArn
```
public String getEndpointArn()
```
    The Amazon Resource Name (ARN) of the endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the endpoint.
  - withEndpointArn
```
public EndpointSummary withEndpointArn(String endpointArn)
```
    The Amazon Resource Name (ARN) of the endpoint.
    
    Parameters:
    
    endpointArn - The Amazon Resource Name (ARN) of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A timestamp that shows when the endpoint was created.
    
    Parameters:
    
    creationTime - A timestamp that shows when the endpoint was created.
  - getCreationTime
```
public Date getCreationTime()
```
    A timestamp that shows when the endpoint was created.
    
    Returns:
    
    A timestamp that shows when the endpoint was created.
  - withCreationTime
```
public EndpointSummary withCreationTime(Date creationTime)
```
    A timestamp that shows when the endpoint was created.
    
    Parameters:
    
    creationTime - A timestamp that shows when the endpoint was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    A timestamp that shows when the endpoint was last modified.
    
    Parameters:
    
    lastModifiedTime - A timestamp that shows when the endpoint was last modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    A timestamp that shows when the endpoint was last modified.
    
    Returns:
    
    A timestamp that shows when the endpoint was last modified.
  - withLastModifiedTime
```
public EndpointSummary withLastModifiedTime(Date lastModifiedTime)
```
    A timestamp that shows when the endpoint was last modified.
    
    Parameters:
    
    lastModifiedTime - A timestamp that shows when the endpoint was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointStatus
```
public void setEndpointStatus(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.
    Parameters:
    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 Also:
    
    EndpointStatus
  - getEndpointStatus
```
public String getEndpointStatus()
```
    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.
    Returns:
    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 Also:
    
    EndpointStatus
  - withEndpointStatus
```
public EndpointSummary withEndpointStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointStatus
  - withEndpointStatus
```
public EndpointSummary withEndpointStatus(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 ListEndpointsInput$StatusEquals filter.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointStatus
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EndpointSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class EndpointSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EndpointSummary

Method Detail

setEndpointName

getEndpointName

withEndpointName

setEndpointArn

getEndpointArn

withEndpointArn

setCreationTime

getCreationTime

withCreationTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setEndpointStatus

getEndpointStatus

withEndpointStatus

withEndpointStatus

toString

equals

hashCode

clone

marshall