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

Interface DescribeInferenceExperimentResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeInferenceExperimentResponse.Builder,DescribeInferenceExperimentResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeInferenceExperimentResponse.Builder,DescribeInferenceExperimentResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeInferenceExperimentResponse
public static interface DescribeInferenceExperimentResponse.Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeInferenceExperimentResponse.Builder,DescribeInferenceExperimentResponse>

  • Method Details

    • arn

      DescribeInferenceExperimentResponse.Builder arn(String arn)

      The ARN of the inference experiment being described.

      Parameters:
      arn - The ARN of the inference experiment being described.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      DescribeInferenceExperimentResponse.Builder name(String name)

      The name of the inference experiment.

      Parameters:
      name - The name of the inference experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      DescribeInferenceExperimentResponse.Builder type(String type)

      The type of the inference experiment.

      Parameters:
      type - The type of the inference experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      DescribeInferenceExperimentResponse.Builder type(InferenceExperimentType type)

      The type of the inference experiment.

      Parameters:
      type - The type of the inference experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • schedule

      DescribeInferenceExperimentResponse.Builder schedule(InferenceExperimentSchedule schedule)

      The duration for which the inference experiment ran or will run.

      Parameters:
      schedule - The duration for which the inference experiment ran or will run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedule

      default DescribeInferenceExperimentResponse.Builder schedule(Consumer<InferenceExperimentSchedule.Builder> schedule)

      The duration for which the inference experiment ran or will run.

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

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

      Parameters:
      schedule - a consumer that will call methods on InferenceExperimentSchedule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DescribeInferenceExperimentResponse.Builder status(String status)

      The status of the inference experiment. The following are the possible statuses for an inference experiment:

      • Creating - Amazon SageMaker is creating your experiment.

      • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

      • Updating - When you make changes to your experiment, your experiment shows as updating.

      • Starting - Amazon SageMaker is beginning your experiment.

      • Running - Your experiment is in progress.

      • Stopping - Amazon SageMaker is stopping your experiment.

      • Completed - Your experiment has completed.

      • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

      Parameters:
      status - The status of the inference experiment. The following are the possible statuses for an inference experiment:

      • Creating - Amazon SageMaker is creating your experiment.

      • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

      • Updating - When you make changes to your experiment, your experiment shows as updating.

      • Starting - Amazon SageMaker is beginning your experiment.

      • Running - Your experiment is in progress.

      • Stopping - Amazon SageMaker is stopping your experiment.

      • Completed - Your experiment has completed.

      • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

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

    • status

      DescribeInferenceExperimentResponse.Builder status(InferenceExperimentStatus status)

      The status of the inference experiment. The following are the possible statuses for an inference experiment:

      • Creating - Amazon SageMaker is creating your experiment.

      • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

      • Updating - When you make changes to your experiment, your experiment shows as updating.

      • Starting - Amazon SageMaker is beginning your experiment.

      • Running - Your experiment is in progress.

      • Stopping - Amazon SageMaker is stopping your experiment.

      • Completed - Your experiment has completed.

      • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

      Parameters:
      status - The status of the inference experiment. The following are the possible statuses for an inference experiment:

      • Creating - Amazon SageMaker is creating your experiment.

      • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

      • Updating - When you make changes to your experiment, your experiment shows as updating.

      • Starting - Amazon SageMaker is beginning your experiment.

      • Running - Your experiment is in progress.

      • Stopping - Amazon SageMaker is stopping your experiment.

      • Completed - Your experiment has completed.

      • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

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

    • statusReason

      DescribeInferenceExperimentResponse.Builder statusReason(String statusReason)

      The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

      Parameters:
      statusReason - The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      DescribeInferenceExperimentResponse.Builder description(String description)

      The description of the inference experiment.

      Parameters:
      description - The description of the inference experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      DescribeInferenceExperimentResponse.Builder creationTime(Instant creationTime)

      The timestamp at which you created the inference experiment.

      Parameters:
      creationTime - The timestamp at which you created the inference experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completionTime

      DescribeInferenceExperimentResponse.Builder completionTime(Instant completionTime)

      The timestamp at which the inference experiment was completed.

      Parameters:
      completionTime - The timestamp at which the inference experiment was completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedTime

      DescribeInferenceExperimentResponse.Builder lastModifiedTime(Instant lastModifiedTime)

      The timestamp at which you last modified the inference experiment.

      Parameters:
      lastModifiedTime - The timestamp at which you last modified the inference experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      DescribeInferenceExperimentResponse.Builder roleArn(String roleArn)

      The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

      Parameters:
      roleArn - The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointMetadata

      DescribeInferenceExperimentResponse.Builder endpointMetadata(EndpointMetadata endpointMetadata)

      The metadata of the endpoint on which the inference experiment ran.

      Parameters:
      endpointMetadata - The metadata of the endpoint on which the inference experiment ran.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointMetadata

      default DescribeInferenceExperimentResponse.Builder endpointMetadata(Consumer<EndpointMetadata.Builder> endpointMetadata)

      The metadata of the endpoint on which the inference experiment ran.

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

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

      Parameters:
      endpointMetadata - a consumer that will call methods on EndpointMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • modelVariants

      DescribeInferenceExperimentResponse.Builder modelVariants(Collection<ModelVariantConfigSummary> modelVariants)

      An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

      Parameters:
      modelVariants - An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelVariants

      DescribeInferenceExperimentResponse.Builder modelVariants(ModelVariantConfigSummary... modelVariants)

      An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

      Parameters:
      modelVariants - An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelVariants

      DescribeInferenceExperimentResponse.Builder modelVariants(Consumer<ModelVariantConfigSummary.Builder>... modelVariants)

      An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

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

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

      Parameters:
      modelVariants - a consumer that will call methods on ModelVariantConfigSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataStorageConfig

      DescribeInferenceExperimentResponse.Builder dataStorageConfig(InferenceExperimentDataStorageConfig dataStorageConfig)

      The Amazon S3 location and configuration for storing inference request and response data.

      Parameters:
      dataStorageConfig - The Amazon S3 location and configuration for storing inference request and response data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataStorageConfig

      default DescribeInferenceExperimentResponse.Builder dataStorageConfig(Consumer<InferenceExperimentDataStorageConfig.Builder> dataStorageConfig)

      The Amazon S3 location and configuration for storing inference request and response data.

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

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

      Parameters:
      dataStorageConfig - a consumer that will call methods on InferenceExperimentDataStorageConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • shadowModeConfig

      DescribeInferenceExperimentResponse.Builder shadowModeConfig(ShadowModeConfig shadowModeConfig)

      The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

      Parameters:
      shadowModeConfig - The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shadowModeConfig

      default DescribeInferenceExperimentResponse.Builder shadowModeConfig(Consumer<ShadowModeConfig.Builder> shadowModeConfig)

      The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

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

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

      Parameters:
      shadowModeConfig - a consumer that will call methods on ShadowModeConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsKey

      DescribeInferenceExperimentResponse.Builder kmsKey(String kmsKey)

      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.

      Parameters:
      kmsKey - The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.