CreateBatchInferenceJobRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

Constructors
Constructor and Description
`CreateBatchInferenceJobRequest ()`

Method Summary

All Methods
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)`
`BatchInferenceJobConfig`	`getBatchInferenceJobConfig ()` The configuration details of a batch inference job.
`String`	`getBatchInferenceJobMode ()` The mode of the batch inference job.
`String`	`getFilterArn ()` The ARN of the filter to apply to the batch inference job.
`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 retrieve.
`String`	`getRoleArn ()` The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output 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.
`List<Tag>`	`getTags ()` A list of tags to apply to the batch inference job.
`ThemeGenerationConfig`	`getThemeGenerationConfig ()` For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
`int`	`hashCode ()`
`void`	`setBatchInferenceJobConfig (BatchInferenceJobConfig batchInferenceJobConfig)` The configuration details of a batch inference job.
`void`	`setBatchInferenceJobMode (String batchInferenceJobMode)` The mode of the batch inference job.
`void`	`setFilterArn (String filterArn)` The ARN of the filter to apply to the batch inference job.
`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 retrieve.
`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 output 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.
`void`	`setTags (Collection<Tag> tags)` A list of tags to apply to the batch inference job.
`void`	`setThemeGenerationConfig (ThemeGenerationConfig themeGenerationConfig)` For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
`String`	`toString ()` Returns a string representation of this object.
`CreateBatchInferenceJobRequest`	`withBatchInferenceJobConfig (BatchInferenceJobConfig batchInferenceJobConfig)` The configuration details of a batch inference job.
`CreateBatchInferenceJobRequest`	`withBatchInferenceJobMode (BatchInferenceJobMode batchInferenceJobMode)` The mode of the batch inference job.
`CreateBatchInferenceJobRequest`	`withBatchInferenceJobMode (String batchInferenceJobMode)` The mode of the batch inference job.
`CreateBatchInferenceJobRequest`	`withFilterArn (String filterArn)` The ARN of the filter to apply to the batch inference job.
`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 retrieve.
`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 output 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.
`CreateBatchInferenceJobRequest`	`withTags (Collection<Tag> tags)` A list of tags to apply to the batch inference job.
`CreateBatchInferenceJobRequest`	`withTags (Tag... tags)` A list of tags to apply to the batch inference job.
`CreateBatchInferenceJobRequest`	`withThemeGenerationConfig (ThemeGenerationConfig themeGenerationConfig)` For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.

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.
  - setFilterArn
```
public void setFilterArn(String filterArn)
```
    The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
    
    Parameters:
    
    filterArn - The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
  - getFilterArn
```
public String getFilterArn()
```
    The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
    
    Returns:
    
    The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
  - withFilterArn
```
public CreateBatchInferenceJobRequest withFilterArn(String filterArn)
```
    The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
    
    Parameters:
    
    filterArn - The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch 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 retrieve.
    
    Parameters:
    
    numResults - The number of recommendations to retrieve.
  - getNumResults
```
public Integer getNumResults()
```
    The number of recommendations to retrieve.
    
    Returns:
    
    The number of recommendations to retrieve.
  - withNumResults
```
public CreateBatchInferenceJobRequest withNumResults(Integer numResults)
```
    The number of recommendations to retrieve.
    
    Parameters:
    
    numResults - The number of recommendations to retrieve.
    
    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 output 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 output 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 output 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 output 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 output 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 output Amazon S3 buckets respectively.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBatchInferenceJobConfig
```
public void setBatchInferenceJobConfig(BatchInferenceJobConfig batchInferenceJobConfig)
```
    The configuration details of a batch inference job.
    
    Parameters:
    
    batchInferenceJobConfig - The configuration details of a batch inference job.
  - getBatchInferenceJobConfig
```
public BatchInferenceJobConfig getBatchInferenceJobConfig()
```
    The configuration details of a batch inference job.
    
    Returns:
    
    The configuration details of a batch inference job.
  - withBatchInferenceJobConfig
```
public CreateBatchInferenceJobRequest withBatchInferenceJobConfig(BatchInferenceJobConfig batchInferenceJobConfig)
```
    The configuration details of a batch inference job.
    
    Parameters:
    
    batchInferenceJobConfig - The configuration details of a batch inference job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    A list of tags to apply to the batch inference job.
    
    Returns:
    
    A list of tags to apply to the batch inference job.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of tags to apply to the batch inference job.
    
    Parameters:
    
    tags - A list of tags to apply to the batch inference job.
  - withTags
```
public CreateBatchInferenceJobRequest withTags(Tag... tags)
```
    A list of tags to apply to the batch inference job.
    
    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 - A list of tags to apply to the batch inference job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateBatchInferenceJobRequest withTags(Collection<Tag> tags)
```
    A list of tags to apply to the batch inference job.
    
    Parameters:
    
    tags - A list of tags to apply to the batch inference job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBatchInferenceJobMode
```
public void setBatchInferenceJobMode(String batchInferenceJobMode)
```
    The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.
    
    When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.
    
    Parameters:
    
    batchInferenceJobMode - The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.
    
    When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.
    
    See Also:
    
    BatchInferenceJobMode
  - getBatchInferenceJobMode
```
public String getBatchInferenceJobMode()
```
    The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.
    
    When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.
    
    Returns:
    
    The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.
    
    When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.
    
    See Also:
    
    BatchInferenceJobMode
  - withBatchInferenceJobMode
```
public CreateBatchInferenceJobRequest withBatchInferenceJobMode(String batchInferenceJobMode)
```
    The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.
    
    When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.
    
    Parameters:
    
    batchInferenceJobMode - The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.
    
    When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BatchInferenceJobMode
  - withBatchInferenceJobMode
```
public CreateBatchInferenceJobRequest withBatchInferenceJobMode(BatchInferenceJobMode batchInferenceJobMode)
```
    The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.
    
    When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.
    
    Parameters:
    
    batchInferenceJobMode - The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.
    
    When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BatchInferenceJobMode
  - setThemeGenerationConfig
```
public void setThemeGenerationConfig(ThemeGenerationConfig themeGenerationConfig)
```
    For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
    
    Parameters:
    
    themeGenerationConfig - For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
  - getThemeGenerationConfig
```
public ThemeGenerationConfig getThemeGenerationConfig()
```
    For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
    
    Returns:
    
    For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
  - withThemeGenerationConfig
```
public CreateBatchInferenceJobRequest withThemeGenerationConfig(ThemeGenerationConfig themeGenerationConfig)
```
    For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
    
    Parameters:
    
    themeGenerationConfig - For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
    
    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()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class CreateBatchInferenceJobRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateBatchInferenceJobRequest

Method Detail

setJobName

getJobName

withJobName

setSolutionVersionArn

getSolutionVersionArn

withSolutionVersionArn

setFilterArn

getFilterArn

withFilterArn

setNumResults

getNumResults

withNumResults

setJobInput

getJobInput

withJobInput

setJobOutput

getJobOutput

withJobOutput

setRoleArn

getRoleArn

withRoleArn

setBatchInferenceJobConfig

getBatchInferenceJobConfig

withBatchInferenceJobConfig

getTags

setTags

withTags

withTags

setBatchInferenceJobMode

getBatchInferenceJobMode

withBatchInferenceJobMode

withBatchInferenceJobMode

setThemeGenerationConfig

getThemeGenerationConfig

withThemeGenerationConfig

toString

equals

hashCode

clone