com.amazonaws.services.personalize.model

Class CreateBatchInferenceJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.personalize.model.CreateBatchInferenceJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateBatchInferenceJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
BatchInferenceJobInput	getJobInput() The Amazon S3 path that leads to the input file to base your recommendations on.
String	getJobName() The name of the batch inference job to create.
BatchInferenceJobOutput	getJobOutput() The path to the Amazon S3 bucket where the job's output will be stored.
Integer	getNumResults() The number of recommendations to retreive.
String	getRoleArn() The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.
String	getSolutionVersionArn() The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
int	hashCode()
void	setJobInput(BatchInferenceJobInput jobInput) The Amazon S3 path that leads to the input file to base your recommendations on.
void	setJobName(String jobName) The name of the batch inference job to create.
void	setJobOutput(BatchInferenceJobOutput jobOutput) The path to the Amazon S3 bucket where the job's output will be stored.
void	setNumResults(Integer numResults) The number of recommendations to retreive.
void	setRoleArn(String roleArn) The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.
void	setSolutionVersionArn(String solutionVersionArn) The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
String	toString() Returns a string representation of this object.
CreateBatchInferenceJobRequest	withJobInput(BatchInferenceJobInput jobInput) The Amazon S3 path that leads to the input file to base your recommendations on.
CreateBatchInferenceJobRequest	withJobName(String jobName) The name of the batch inference job to create.
CreateBatchInferenceJobRequest	withJobOutput(BatchInferenceJobOutput jobOutput) The path to the Amazon S3 bucket where the job's output will be stored.
CreateBatchInferenceJobRequest	withNumResults(Integer numResults) The number of recommendations to retreive.
CreateBatchInferenceJobRequest	withRoleArn(String roleArn) The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.
CreateBatchInferenceJobRequest	withSolutionVersionArn(String solutionVersionArn) The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

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

CreateBatchInferenceJobRequest

public CreateBatchInferenceJobRequest()

Method Detail

setJobName

public void setJobName(String jobName)

The name of the batch inference job to create.

Parameters:

jobName - The name of the batch inference job to create.

getJobName

public String getJobName()

The name of the batch inference job to create.

Returns:

The name of the batch inference job to create.

withJobName

public CreateBatchInferenceJobRequest withJobName(String jobName)

The name of the batch inference job to create.

Parameters:

jobName - The name of the batch inference job to create.

Returns:

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

setSolutionVersionArn

public void setSolutionVersionArn(String solutionVersionArn)

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

Parameters:

solutionVersionArn - The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

getSolutionVersionArn

public String getSolutionVersionArn()

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

Returns:

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

withSolutionVersionArn

public CreateBatchInferenceJobRequest withSolutionVersionArn(String solutionVersionArn)

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

Parameters:

solutionVersionArn - The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

Returns:

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

setNumResults

public void setNumResults(Integer numResults)

The number of recommendations to retreive.

Parameters:

numResults - The number of recommendations to retreive.

getNumResults

public Integer getNumResults()

The number of recommendations to retreive.

Returns:

The number of recommendations to retreive.

withNumResults

public CreateBatchInferenceJobRequest withNumResults(Integer numResults)

The number of recommendations to retreive.

Parameters:

numResults - The number of recommendations to retreive.

Returns:

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

setJobInput

public void setJobInput(BatchInferenceJobInput jobInput)

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

Parameters:

jobInput - The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

getJobInput

public BatchInferenceJobInput getJobInput()

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

Returns:

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

withJobInput

public CreateBatchInferenceJobRequest withJobInput(BatchInferenceJobInput jobInput)

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

Parameters:

jobInput - The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

Returns:

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

setJobOutput

public void setJobOutput(BatchInferenceJobOutput jobOutput)

The path to the Amazon S3 bucket where the job's output will be stored.

Parameters:

jobOutput - The path to the Amazon S3 bucket where the job's output will be stored.

getJobOutput

public BatchInferenceJobOutput getJobOutput()

The path to the Amazon S3 bucket where the job's output will be stored.

Returns:

The path to the Amazon S3 bucket where the job's output will be stored.

withJobOutput

public CreateBatchInferenceJobRequest withJobOutput(BatchInferenceJobOutput jobOutput)

The path to the Amazon S3 bucket where the job's output will be stored.

Parameters:

jobOutput - The path to the Amazon S3 bucket where the job's output will be stored.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.

Parameters:

roleArn - The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.

getRoleArn

public String getRoleArn()

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.

Returns:

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.

withRoleArn

public CreateBatchInferenceJobRequest withRoleArn(String roleArn)

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.

Parameters:

roleArn - The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.

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