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

Class StopInferenceExperimentRequest

    • Method Detail

      • name

        public final String name()

        The name of the inference experiment to stop.

        Returns:
        The name of the inference experiment to stop.

      • modelVariantActions

        public final 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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasModelVariantActions() method.

        Returns:
        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

      • hasModelVariantActions

        public final boolean hasModelVariantActions()
        For responses, this returns true if the service returned a value for the ModelVariantActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • modelVariantActionsAsStrings

        public final Map<String,​String> modelVariantActionsAsStrings()

        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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasModelVariantActions() method.

        Returns:
        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

      • hasDesiredModelVariants

        public final boolean hasDesiredModelVariants()
        For responses, this returns true if the service returned a value for the DesiredModelVariants property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • desiredModelVariants

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDesiredModelVariants() method.

        Returns:
        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.

      • desiredStateAsString

        public final String desiredStateAsString()

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

        • Completed: The experiment completed successfully

        • Cancelled: The experiment was canceled

        If the service returns an enum value that is not available in the current SDK version, desiredState will return InferenceExperimentStopDesiredState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from desiredStateAsString().

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

        • Completed: The experiment completed successfully

        • Cancelled: The experiment was canceled

        See Also:
        InferenceExperimentStopDesiredState

      • reason

        public final String reason()

        The reason for stopping the experiment.

        Returns:
        The reason for stopping the experiment.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object