software.amazon.awssdk.services.sagemaker.model

Interface DescribeEndpointResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeEndpointResponse

public static interface DescribeEndpointResponse.Builder
extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>

Method Summary

Modifier and Type	Method and Description
DescribeEndpointResponse.Builder	creationTime(Instant creationTime) A timestamp that shows when the endpoint was created.
DescribeEndpointResponse.Builder	endpointArn(String endpointArn) The Amazon Resource Name (ARN) of the endpoint.
DescribeEndpointResponse.Builder	endpointConfigName(String endpointConfigName) The name of the endpoint configuration associated with this endpoint.
DescribeEndpointResponse.Builder	endpointName(String endpointName) Name of the endpoint.
DescribeEndpointResponse.Builder	endpointStatus(EndpointStatus endpointStatus) The status of the endpoint.
DescribeEndpointResponse.Builder	endpointStatus(String endpointStatus) The status of the endpoint.
DescribeEndpointResponse.Builder	failureReason(String failureReason) If the status of the endpoint is Failed, the reason why it failed.
DescribeEndpointResponse.Builder	lastModifiedTime(Instant lastModifiedTime) A timestamp that shows when the endpoint was last modified.
DescribeEndpointResponse.Builder	productionVariants(Collection<ProductionVariantSummary> productionVariants) An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
DescribeEndpointResponse.Builder	productionVariants(Consumer<ProductionVariantSummary.Builder>... productionVariants) An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
DescribeEndpointResponse.Builder	productionVariants(ProductionVariantSummary... productionVariants) An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

endpointName

DescribeEndpointResponse.Builder endpointName(String endpointName)

Name of the endpoint.

Parameters:

endpointName - Name of the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpointArn

DescribeEndpointResponse.Builder endpointArn(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.

endpointConfigName

DescribeEndpointResponse.Builder endpointConfigName(String endpointConfigName)

The name of the endpoint configuration associated with this endpoint.

Parameters:

endpointConfigName - The name of the endpoint configuration associated with this endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

productionVariants

DescribeEndpointResponse.Builder productionVariants(Collection<ProductionVariantSummary> productionVariants)

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

Parameters:

productionVariants - An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

productionVariants

DescribeEndpointResponse.Builder productionVariants(ProductionVariantSummary... productionVariants)

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

Parameters:

productionVariants - An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

productionVariants

DescribeEndpointResponse.Builder productionVariants(Consumer<ProductionVariantSummary.Builder>... productionVariants)

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #productionVariants(List).

Parameters:

productionVariants - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#productionVariants(List)

endpointStatus

DescribeEndpointResponse.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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndpointStatus, EndpointStatus

endpointStatus

DescribeEndpointResponse.Builder endpointStatus(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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndpointStatus, EndpointStatus

failureReason

DescribeEndpointResponse.Builder failureReason(String failureReason)

If the status of the endpoint is Failed, the reason why it failed.

Parameters:

failureReason - If the status of the endpoint is Failed, the reason why it failed.

Returns:

Returns a reference to this object so that method calls can be chained together.

creationTime

DescribeEndpointResponse.Builder creationTime(Instant 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.

lastModifiedTime

DescribeEndpointResponse.Builder lastModifiedTime(Instant 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.