Interface CreateBatchInferenceJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateBatchInferenceJobRequest.Builder,CreateBatchInferenceJobRequest>, PersonalizeRequest.Builder, SdkBuilder<CreateBatchInferenceJobRequest.Builder,CreateBatchInferenceJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateBatchInferenceJobRequest

public static interface CreateBatchInferenceJobRequest.Builder
extends PersonalizeRequest.Builder, SdkPojo, CopyableBuilder<CreateBatchInferenceJobRequest.Builder,CreateBatchInferenceJobRequest>

Method Summary

Modifier and Type	Method	Description
default CreateBatchInferenceJobRequest.Builder	batchInferenceJobConfig(Consumer<BatchInferenceJobConfig.Builder> batchInferenceJobConfig)	The configuration details of a batch inference job.
CreateBatchInferenceJobRequest.Builder	batchInferenceJobConfig(BatchInferenceJobConfig batchInferenceJobConfig)	The configuration details of a batch inference job.
CreateBatchInferenceJobRequest.Builder	batchInferenceJobMode(String batchInferenceJobMode)	The mode of the batch inference job.
CreateBatchInferenceJobRequest.Builder	batchInferenceJobMode(BatchInferenceJobMode batchInferenceJobMode)	The mode of the batch inference job.
CreateBatchInferenceJobRequest.Builder	filterArn(String filterArn)	The ARN of the filter to apply to the batch inference job.
default CreateBatchInferenceJobRequest.Builder	jobInput(Consumer<BatchInferenceJobInput.Builder> jobInput)	The Amazon S3 path that leads to the input file to base your recommendations on.
CreateBatchInferenceJobRequest.Builder	jobInput(BatchInferenceJobInput jobInput)	The Amazon S3 path that leads to the input file to base your recommendations on.
CreateBatchInferenceJobRequest.Builder	jobName(String jobName)	The name of the batch inference job to create.
default CreateBatchInferenceJobRequest.Builder	jobOutput(Consumer<BatchInferenceJobOutput.Builder> jobOutput)	The path to the Amazon S3 bucket where the job's output will be stored.
CreateBatchInferenceJobRequest.Builder	jobOutput(BatchInferenceJobOutput jobOutput)	The path to the Amazon S3 bucket where the job's output will be stored.
CreateBatchInferenceJobRequest.Builder	numResults(Integer numResults)	The number of recommendations to retrieve.
CreateBatchInferenceJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateBatchInferenceJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateBatchInferenceJobRequest.Builder	roleArn(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.Builder	solutionVersionArn(String solutionVersionArn)	The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
CreateBatchInferenceJobRequest.Builder	tags(Collection<Tag> tags)	A list of tags to apply to the batch inference job.
CreateBatchInferenceJobRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of tags to apply to the batch inference job.
CreateBatchInferenceJobRequest.Builder	tags(Tag... tags)	A list of tags to apply to the batch inference job.
default CreateBatchInferenceJobRequest.Builder	themeGenerationConfig(Consumer<ThemeGenerationConfig.Builder> themeGenerationConfig)	For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
CreateBatchInferenceJobRequest.Builder	themeGenerationConfig(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 interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.personalize.model.PersonalizeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

jobName

CreateBatchInferenceJobRequest.Builder jobName(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.

solutionVersionArn

CreateBatchInferenceJobRequest.Builder solutionVersionArn(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.

filterArn

CreateBatchInferenceJobRequest.Builder filterArn(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.

numResults

CreateBatchInferenceJobRequest.Builder numResults(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.

jobInput

CreateBatchInferenceJobRequest.Builder jobInput(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.

jobInput

default CreateBatchInferenceJobRequest.Builder jobInput(Consumer<BatchInferenceJobInput.Builder> jobInput)

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

This is a convenience method that creates an instance of the BatchInferenceJobInput.Builder avoiding the need to create one manually via BatchInferenceJobInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobInput(BatchInferenceJobInput).

Parameters:

jobInput - a consumer that will call methods on BatchInferenceJobInput.Builder

Returns:

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

See Also:

• jobInput(BatchInferenceJobInput)

jobOutput

CreateBatchInferenceJobRequest.Builder jobOutput(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.

jobOutput

default CreateBatchInferenceJobRequest.Builder jobOutput(Consumer<BatchInferenceJobOutput.Builder> jobOutput)

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

This is a convenience method that creates an instance of the BatchInferenceJobOutput.Builder avoiding the need to create one manually via BatchInferenceJobOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobOutput(BatchInferenceJobOutput).

Parameters:

jobOutput - a consumer that will call methods on BatchInferenceJobOutput.Builder

Returns:

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

See Also:

• jobOutput(BatchInferenceJobOutput)

roleArn

CreateBatchInferenceJobRequest.Builder roleArn(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.

batchInferenceJobConfig

CreateBatchInferenceJobRequest.Builder batchInferenceJobConfig(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.

batchInferenceJobConfig

default CreateBatchInferenceJobRequest.Builder batchInferenceJobConfig(Consumer<BatchInferenceJobConfig.Builder> batchInferenceJobConfig)

The configuration details of a batch inference job.

This is a convenience method that creates an instance of the BatchInferenceJobConfig.Builder avoiding the need to create one manually via BatchInferenceJobConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to batchInferenceJobConfig(BatchInferenceJobConfig).

Parameters:

batchInferenceJobConfig - a consumer that will call methods on BatchInferenceJobConfig.Builder

Returns:

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

See Also:

• batchInferenceJobConfig(BatchInferenceJobConfig)

tags

CreateBatchInferenceJobRequest.Builder tags(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.

tags

CreateBatchInferenceJobRequest.Builder tags(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.

tags

CreateBatchInferenceJobRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of tags to apply to the batch inference job.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

batchInferenceJobMode

CreateBatchInferenceJobRequest.Builder batchInferenceJobMode(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
• BatchInferenceJobMode

batchInferenceJobMode

CreateBatchInferenceJobRequest.Builder batchInferenceJobMode(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
• BatchInferenceJobMode

themeGenerationConfig

CreateBatchInferenceJobRequest.Builder themeGenerationConfig(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.

themeGenerationConfig

default CreateBatchInferenceJobRequest.Builder themeGenerationConfig(Consumer<ThemeGenerationConfig.Builder> themeGenerationConfig)

For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.

This is a convenience method that creates an instance of the ThemeGenerationConfig.Builder avoiding the need to create one manually via ThemeGenerationConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to themeGenerationConfig(ThemeGenerationConfig).

Parameters:

themeGenerationConfig - a consumer that will call methods on ThemeGenerationConfig.Builder

Returns:

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

See Also:

• themeGenerationConfig(ThemeGenerationConfig)

overrideConfiguration

CreateBatchInferenceJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateBatchInferenceJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.