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

Interface StopInferenceExperimentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StopInferenceExperimentRequest.Builder,StopInferenceExperimentRequest>, SageMakerRequest.Builder, SdkBuilder<StopInferenceExperimentRequest.Builder,StopInferenceExperimentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StopInferenceExperimentRequest
public static interface StopInferenceExperimentRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<StopInferenceExperimentRequest.Builder,StopInferenceExperimentRequest>

  • Method Details

    • name

      StopInferenceExperimentRequest.Builder name(String name)

      The name of the inference experiment to stop.

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

    • modelVariantActionsWithStrings

      StopInferenceExperimentRequest.Builder modelVariantActionsWithStrings(Map<String,String> modelVariantActions)

      Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

      • Promote - Promote the shadow variant to a production variant

      • Remove - Delete the variant

      • Retain - Keep the variant as it is

      Parameters:
      modelVariantActions - Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

      • Promote - Promote the shadow variant to a production variant

      • Remove - Delete the variant

      • Retain - Keep the variant as it is

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

    • modelVariantActions

      StopInferenceExperimentRequest.Builder modelVariantActions(Map<String,ModelVariantAction> modelVariantActions)

      Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

      • Promote - Promote the shadow variant to a production variant

      • Remove - Delete the variant

      • Retain - Keep the variant as it is

      Parameters:
      modelVariantActions - Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

      • Promote - Promote the shadow variant to a production variant

      • Remove - Delete the variant

      • Retain - Keep the variant as it is

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

    • desiredModelVariants

      StopInferenceExperimentRequest.Builder desiredModelVariants(Collection<ModelVariantConfig> desiredModelVariants)

      An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

      Parameters:
      desiredModelVariants - An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • desiredModelVariants

      StopInferenceExperimentRequest.Builder desiredModelVariants(ModelVariantConfig... desiredModelVariants)

      An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

      Parameters:
      desiredModelVariants - An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • desiredModelVariants

      StopInferenceExperimentRequest.Builder desiredModelVariants(Consumer<ModelVariantConfig.Builder>... desiredModelVariants)

      An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

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

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

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

    • desiredState

      StopInferenceExperimentRequest.Builder desiredState(String desiredState)

      The desired state of the experiment after stopping. The possible states are the following:

      • Completed: The experiment completed successfully

      • Cancelled: The experiment was canceled

      Parameters:
      desiredState - The desired state of the experiment after stopping. The possible states are the following:

      • Completed: The experiment completed successfully

      • Cancelled: The experiment was canceled

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

    • desiredState

      StopInferenceExperimentRequest.Builder desiredState(InferenceExperimentStopDesiredState desiredState)

      The desired state of the experiment after stopping. The possible states are the following:

      • Completed: The experiment completed successfully

      • Cancelled: The experiment was canceled

      Parameters:
      desiredState - The desired state of the experiment after stopping. The possible states are the following:

      • Completed: The experiment completed successfully

      • Cancelled: The experiment was canceled

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

    • reason

      StopInferenceExperimentRequest.Builder reason(String reason)

      The reason for stopping the experiment.

      Parameters:
      reason - The reason for stopping the experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StopInferenceExperimentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StopInferenceExperimentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.