Package software.amazon.awssdk.services.sagemaker.model

Interface DescribeEndpointResponse.Builder

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

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

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

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

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

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