All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StopInferenceExperimentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  StopInferenceExperimentRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  StopInferenceExperimentRequest	addModelVariantActionsEntry (String key, String value) Add a single ModelVariantActions entry
  StopInferenceExperimentRequest	clearModelVariantActionsEntries () Removes all the entries added into ModelVariantActions.
  StopInferenceExperimentRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  List<ModelVariantConfig>	getDesiredModelVariants () An array of ModelVariantConfig objects.
  String	getDesiredState () The desired state of the experiment after stopping.
  Map<String,String>	getModelVariantActions () Array of key-value pairs, with names of variants mapped to actions.
  String	getName () The name of the inference experiment to stop.
  String	getReason () The reason for stopping the experiment.
  int	hashCode ()
  void	setDesiredModelVariants (Collection<ModelVariantConfig> desiredModelVariants) An array of ModelVariantConfig objects.
  void	setDesiredState (String desiredState) The desired state of the experiment after stopping.
  void	setModelVariantActions (Map<String,String> modelVariantActions) Array of key-value pairs, with names of variants mapped to actions.
  void	setName (String name) The name of the inference experiment to stop.
  void	setReason (String reason) The reason for stopping the experiment.
  String	toString () Returns a string representation of this object.
  StopInferenceExperimentRequest	withDesiredModelVariants (Collection<ModelVariantConfig> desiredModelVariants) An array of ModelVariantConfig objects.
  StopInferenceExperimentRequest	withDesiredModelVariants (ModelVariantConfig... desiredModelVariants) An array of ModelVariantConfig objects.
  StopInferenceExperimentRequest	withDesiredState (InferenceExperimentStopDesiredState desiredState) The desired state of the experiment after stopping.
  StopInferenceExperimentRequest	withDesiredState (String desiredState) The desired state of the experiment after stopping.
  StopInferenceExperimentRequest	withModelVariantActions (Map<String,String> modelVariantActions) Array of key-value pairs, with names of variants mapped to actions.
  StopInferenceExperimentRequest	withName (String name) The name of the inference experiment to stop.
  StopInferenceExperimentRequest	withReason (String reason) The reason for stopping the experiment.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • StopInferenceExperimentRequest

    public StopInferenceExperimentRequest()

• Method Detail

  • setName

    public void setName(String name)

    The name of the inference experiment to stop.

    Parameters:

    name - The name of the inference experiment to stop.

  • getName

    public String getName()

    The name of the inference experiment to stop.

    Returns:

    The name of the inference experiment to stop.

  • withName

    public StopInferenceExperimentRequest withName(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.

  • getModelVariantActions

    public Map<String,String> getModelVariantActions()

    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:

    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

  • setModelVariantActions

    public void setModelVariantActions(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

  • withModelVariantActions

    public StopInferenceExperimentRequest withModelVariantActions(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.

  • addModelVariantActionsEntry

    public StopInferenceExperimentRequest addModelVariantActionsEntry(String key,
     String value)

    Add a single ModelVariantActions entry

    See Also:

    withModelVariantActions(java.util.Map<java.lang.String, java.lang.String>)

  • clearModelVariantActionsEntries

    public StopInferenceExperimentRequest clearModelVariantActionsEntries()

    Removes all the entries added into ModelVariantActions.

    Returns:

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

  • getDesiredModelVariants

    public List<ModelVariantConfig> getDesiredModelVariants()

    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:

    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.

  • setDesiredModelVariants

    public void setDesiredModelVariants(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.

  • withDesiredModelVariants

    public StopInferenceExperimentRequest withDesiredModelVariants(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.

    NOTE: This method appends the values to the existing list (if any). Use setDesiredModelVariants(java.util.Collection) or withDesiredModelVariants(java.util.Collection) if you want to override the existing values.

    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.

  • withDesiredModelVariants

    public StopInferenceExperimentRequest withDesiredModelVariants(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.

  • setDesiredState

    public void setDesiredState(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

    See Also:

    InferenceExperimentStopDesiredState

  • getDesiredState

    public String getDesiredState()

    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:

    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

  • withDesiredState

    public StopInferenceExperimentRequest withDesiredState(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:

    InferenceExperimentStopDesiredState

  • withDesiredState

    public StopInferenceExperimentRequest withDesiredState(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:

    InferenceExperimentStopDesiredState

  • setReason

    public void setReason(String reason)

    The reason for stopping the experiment.

    Parameters:

    reason - The reason for stopping the experiment.

  • getReason

    public String getReason()

    The reason for stopping the experiment.

    Returns:

    The reason for stopping the experiment.

  • withReason

    public StopInferenceExperimentRequest withReason(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.

  • toString

    public 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

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public StopInferenceExperimentRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()