Package 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	Description
default DescribeEndpointResponse.Builder	asyncInferenceConfig(Consumer<AsyncInferenceConfig.Builder> asyncInferenceConfig)	Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
DescribeEndpointResponse.Builder	asyncInferenceConfig(AsyncInferenceConfig asyncInferenceConfig)	Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
DescribeEndpointResponse.Builder	creationTime(Instant creationTime)	A timestamp that shows when the endpoint was created.
default DescribeEndpointResponse.Builder	dataCaptureConfig(Consumer<DataCaptureConfigSummary.Builder> dataCaptureConfig)	Sets the value of the DataCaptureConfig property for this object.
DescribeEndpointResponse.Builder	dataCaptureConfig(DataCaptureConfigSummary dataCaptureConfig)	Sets the value of the DataCaptureConfig property for this object.
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(String endpointStatus)	The status of the endpoint.
DescribeEndpointResponse.Builder	endpointStatus(EndpointStatus endpointStatus)	The status of the endpoint.
default DescribeEndpointResponse.Builder	explainerConfig(Consumer<ExplainerConfig.Builder> explainerConfig)	The configuration parameters for an explainer.
DescribeEndpointResponse.Builder	explainerConfig(ExplainerConfig explainerConfig)	The configuration parameters for an explainer.
DescribeEndpointResponse.Builder	failureReason(String failureReason)	If the status of the endpoint is Failed, the reason why it failed.
default DescribeEndpointResponse.Builder	lastDeploymentConfig(Consumer<DeploymentConfig.Builder> lastDeploymentConfig)	The most recent deployment configuration for the endpoint.
DescribeEndpointResponse.Builder	lastDeploymentConfig(DeploymentConfig lastDeploymentConfig)	The most recent deployment configuration for the endpoint.
DescribeEndpointResponse.Builder	lastModifiedTime(Instant lastModifiedTime)	A timestamp that shows when the endpoint was last modified.
default DescribeEndpointResponse.Builder	pendingDeploymentSummary(Consumer<PendingDeploymentSummary.Builder> pendingDeploymentSummary)	Returns the summary of an in-progress deployment.
DescribeEndpointResponse.Builder	pendingDeploymentSummary(PendingDeploymentSummary pendingDeploymentSummary)	Returns the summary of an in-progress deployment.
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.
DescribeEndpointResponse.Builder	shadowProductionVariants(Collection<ProductionVariantSummary> 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 on ProductionVariants.
DescribeEndpointResponse.Builder	shadowProductionVariants(Consumer<ProductionVariantSummary.Builder>... 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 on ProductionVariants.
DescribeEndpointResponse.Builder	shadowProductionVariants(ProductionVariantSummary... 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 on ProductionVariants.

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

copy

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

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

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

sdkHttpResponse, sdkHttpResponse

Method Details

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 method that creates an instance of the ProductionVariantSummary.Builder avoiding the need to create one manually via ProductionVariantSummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to productionVariants(List<ProductionVariantSummary>).

Parameters:

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

Returns:

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

See Also:

• productionVariants(java.util.Collection<ProductionVariantSummary>)

dataCaptureConfig

DescribeEndpointResponse.Builder dataCaptureConfig(DataCaptureConfigSummary dataCaptureConfig)

Sets the value of the DataCaptureConfig property for this object.

Parameters:

dataCaptureConfig - The new value for the DataCaptureConfig property for this object.

Returns:

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

dataCaptureConfig

default DescribeEndpointResponse.Builder dataCaptureConfig(Consumer<DataCaptureConfigSummary.Builder> dataCaptureConfig)

Sets the value of the DataCaptureConfig property for this object. This is a convenience method that creates an instance of the DataCaptureConfigSummary.Builder avoiding the need to create one manually via DataCaptureConfigSummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataCaptureConfig(DataCaptureConfigSummary).

Parameters:

dataCaptureConfig - a consumer that will call methods on DataCaptureConfigSummary.Builder

Returns:

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

See Also:

• dataCaptureConfig(DataCaptureConfigSummary)

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 the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

• UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.

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 the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

• UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.

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 the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

• UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.

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 the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

• UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.

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.

lastDeploymentConfig

DescribeEndpointResponse.Builder lastDeploymentConfig(DeploymentConfig lastDeploymentConfig)

The most recent deployment configuration for the endpoint.

Parameters:

lastDeploymentConfig - The most recent deployment configuration for the endpoint.

Returns:

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

lastDeploymentConfig

default DescribeEndpointResponse.Builder lastDeploymentConfig(Consumer<DeploymentConfig.Builder> lastDeploymentConfig)

The most recent deployment configuration for the endpoint.

This is a convenience method that creates an instance of the DeploymentConfig.Builder avoiding the need to create one manually via DeploymentConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastDeploymentConfig(DeploymentConfig).

Parameters:

lastDeploymentConfig - a consumer that will call methods on DeploymentConfig.Builder

Returns:

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

See Also:

• lastDeploymentConfig(DeploymentConfig)

asyncInferenceConfig

DescribeEndpointResponse.Builder asyncInferenceConfig(AsyncInferenceConfig asyncInferenceConfig)

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

Parameters:

asyncInferenceConfig - Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

Returns:

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

asyncInferenceConfig

default DescribeEndpointResponse.Builder asyncInferenceConfig(Consumer<AsyncInferenceConfig.Builder> asyncInferenceConfig)

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

This is a convenience method that creates an instance of the AsyncInferenceConfig.Builder avoiding the need to create one manually via AsyncInferenceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to asyncInferenceConfig(AsyncInferenceConfig).

Parameters:

asyncInferenceConfig - a consumer that will call methods on AsyncInferenceConfig.Builder

Returns:

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

See Also:

• asyncInferenceConfig(AsyncInferenceConfig)

pendingDeploymentSummary

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

Parameters:

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.

Returns:

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

pendingDeploymentSummary

default DescribeEndpointResponse.Builder pendingDeploymentSummary(Consumer<PendingDeploymentSummary.Builder> 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.

This is a convenience method that creates an instance of the PendingDeploymentSummary.Builder avoiding the need to create one manually via PendingDeploymentSummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pendingDeploymentSummary(PendingDeploymentSummary).

Parameters:

pendingDeploymentSummary - a consumer that will call methods on PendingDeploymentSummary.Builder

Returns:

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

See Also:

• pendingDeploymentSummary(PendingDeploymentSummary)

explainerConfig

DescribeEndpointResponse.Builder explainerConfig(ExplainerConfig explainerConfig)

The configuration parameters for an explainer.

Parameters:

explainerConfig - The configuration parameters for an explainer.

Returns:

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

explainerConfig

default DescribeEndpointResponse.Builder explainerConfig(Consumer<ExplainerConfig.Builder> explainerConfig)

The configuration parameters for an explainer.

This is a convenience method that creates an instance of the ExplainerConfig.Builder avoiding the need to create one manually via ExplainerConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to explainerConfig(ExplainerConfig).

Parameters:

explainerConfig - a consumer that will call methods on ExplainerConfig.Builder

Returns:

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

See Also:

• explainerConfig(ExplainerConfig)

shadowProductionVariants

DescribeEndpointResponse.Builder shadowProductionVariants(Collection<ProductionVariantSummary> 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 on ProductionVariants.

Parameters:

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 on ProductionVariants.

Returns:

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

shadowProductionVariants

DescribeEndpointResponse.Builder shadowProductionVariants(ProductionVariantSummary... 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 on ProductionVariants.

Parameters:

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 on ProductionVariants.

Returns:

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

shadowProductionVariants

DescribeEndpointResponse.Builder shadowProductionVariants(Consumer<ProductionVariantSummary.Builder>... 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 on ProductionVariants.

This is a convenience method that creates an instance of the ProductionVariantSummary.Builder avoiding the need to create one manually via ProductionVariantSummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to shadowProductionVariants(List<ProductionVariantSummary>).

Parameters:

shadowProductionVariants - a consumer that will call methods on ProductionVariantSummary.Builder

Returns:

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

See Also:

• shadowProductionVariants(java.util.Collection<ProductionVariantSummary>)