All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateInferenceRecommendationsJobRequest
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
  CreateInferenceRecommendationsJobRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  CreateInferenceRecommendationsJobRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  RecommendationJobInputConfig	getInputConfig () Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
  String	getJobDescription () Description of the recommendation job.
  String	getJobName () A name for the recommendation job.
  String	getJobType () Defines the type of recommendation job.
  RecommendationJobOutputConfig	getOutputConfig () Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
  String	getRoleArn () The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
  RecommendationJobStoppingConditions	getStoppingConditions () A set of conditions for stopping a recommendation job.
  List<Tag>	getTags () The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
  int	hashCode ()
  void	setInputConfig (RecommendationJobInputConfig inputConfig) Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
  void	setJobDescription (String jobDescription) Description of the recommendation job.
  void	setJobName (String jobName) A name for the recommendation job.
  void	setJobType (String jobType) Defines the type of recommendation job.
  void	setOutputConfig (RecommendationJobOutputConfig outputConfig) Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
  void	setRoleArn (String roleArn) The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
  void	setStoppingConditions (RecommendationJobStoppingConditions stoppingConditions) A set of conditions for stopping a recommendation job.
  void	setTags (Collection<Tag> tags) The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
  String	toString () Returns a string representation of this object.
  CreateInferenceRecommendationsJobRequest	withInputConfig (RecommendationJobInputConfig inputConfig) Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
  CreateInferenceRecommendationsJobRequest	withJobDescription (String jobDescription) Description of the recommendation job.
  CreateInferenceRecommendationsJobRequest	withJobName (String jobName) A name for the recommendation job.
  CreateInferenceRecommendationsJobRequest	withJobType (RecommendationJobType jobType) Defines the type of recommendation job.
  CreateInferenceRecommendationsJobRequest	withJobType (String jobType) Defines the type of recommendation job.
  CreateInferenceRecommendationsJobRequest	withOutputConfig (RecommendationJobOutputConfig outputConfig) Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
  CreateInferenceRecommendationsJobRequest	withRoleArn (String roleArn) The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
  CreateInferenceRecommendationsJobRequest	withStoppingConditions (RecommendationJobStoppingConditions stoppingConditions) A set of conditions for stopping a recommendation job.
  CreateInferenceRecommendationsJobRequest	withTags (Collection<Tag> tags) The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
  CreateInferenceRecommendationsJobRequest	withTags (Tag... tags) The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

  • 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

  • CreateInferenceRecommendationsJobRequest

    public CreateInferenceRecommendationsJobRequest()

• Method Detail

  • setJobName

    public void setJobName(String jobName)

    A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

    Parameters:

    jobName - A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

  • getJobName

    public String getJobName()

    A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

    Returns:

    A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

  • withJobName

    public CreateInferenceRecommendationsJobRequest withJobName(String jobName)

    A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

    Parameters:

    jobName - A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

    Returns:

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

  • setJobType

    public void setJobType(String jobType)

    Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

    Parameters:

    jobType - Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

    See Also:

    RecommendationJobType

  • getJobType

    public String getJobType()

    Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

    Returns:

    Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

    See Also:

    RecommendationJobType

  • withJobType

    public CreateInferenceRecommendationsJobRequest withJobType(String jobType)

    Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

    Parameters:

    jobType - Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

    Returns:

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

    See Also:

    RecommendationJobType

  • withJobType

    public CreateInferenceRecommendationsJobRequest withJobType(RecommendationJobType jobType)

    Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

    Parameters:

    jobType - Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

    Returns:

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

    See Also:

    RecommendationJobType

  • setRoleArn

    public void setRoleArn(String roleArn)

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    Parameters:

    roleArn - The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

  • getRoleArn

    public String getRoleArn()

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    Returns:

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

  • withRoleArn

    public CreateInferenceRecommendationsJobRequest withRoleArn(String roleArn)

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    Parameters:

    roleArn - The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    Returns:

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

  • setInputConfig

    public void setInputConfig(RecommendationJobInputConfig inputConfig)

    Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

    Parameters:

    inputConfig - Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

  • getInputConfig

    public RecommendationJobInputConfig getInputConfig()

    Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

    Returns:

    Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

  • withInputConfig

    public CreateInferenceRecommendationsJobRequest withInputConfig(RecommendationJobInputConfig inputConfig)

    Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

    Parameters:

    inputConfig - Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

    Returns:

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

  • setJobDescription

    public void setJobDescription(String jobDescription)

    Description of the recommendation job.

    Parameters:

    jobDescription - Description of the recommendation job.

  • getJobDescription

    public String getJobDescription()

    Description of the recommendation job.

    Returns:

    Description of the recommendation job.

  • withJobDescription

    public CreateInferenceRecommendationsJobRequest withJobDescription(String jobDescription)

    Description of the recommendation job.

    Parameters:

    jobDescription - Description of the recommendation job.

    Returns:

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

  • setStoppingConditions

    public void setStoppingConditions(RecommendationJobStoppingConditions stoppingConditions)

    A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

    Parameters:

    stoppingConditions - A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

  • getStoppingConditions

    public RecommendationJobStoppingConditions getStoppingConditions()

    A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

    Returns:

    A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

  • withStoppingConditions

    public CreateInferenceRecommendationsJobRequest withStoppingConditions(RecommendationJobStoppingConditions stoppingConditions)

    A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

    Parameters:

    stoppingConditions - A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

    Returns:

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

  • setOutputConfig

    public void setOutputConfig(RecommendationJobOutputConfig outputConfig)

    Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

    Parameters:

    outputConfig - Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

  • getOutputConfig

    public RecommendationJobOutputConfig getOutputConfig()

    Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

    Returns:

    Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

  • withOutputConfig

    public CreateInferenceRecommendationsJobRequest withOutputConfig(RecommendationJobOutputConfig outputConfig)

    Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

    Parameters:

    outputConfig - Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

    Returns:

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

  • getTags

    public List<Tag> getTags()

    The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

    Returns:

    The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

  • setTags

    public void setTags(Collection<Tag> tags)

    The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

    Parameters:

    tags - The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

  • withTags

    public CreateInferenceRecommendationsJobRequest withTags(Tag... tags)

    The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

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

    Parameters:

    tags - The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

    Returns:

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

  • withTags

    public CreateInferenceRecommendationsJobRequest withTags(Collection<Tag> tags)

    The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

    Parameters:

    tags - The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

    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 CreateInferenceRecommendationsJobRequest 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()