Interface CreateBatchSegmentJobRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateBatchSegmentJobRequest.Builder,
,CreateBatchSegmentJobRequest> PersonalizeRequest.Builder
,SdkBuilder<CreateBatchSegmentJobRequest.Builder,
,CreateBatchSegmentJobRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateBatchSegmentJobRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the filter to apply to the batch segment job.jobInput
(Consumer<BatchSegmentJobInput.Builder> jobInput) The Amazon S3 path for the input data used to generate the batch segment job.jobInput
(BatchSegmentJobInput jobInput) The Amazon S3 path for the input data used to generate the batch segment job.The name of the batch segment job to create.jobOutput
(Consumer<BatchSegmentJobOutput.Builder> jobOutput) The Amazon S3 path for the bucket where the job's output will be stored.jobOutput
(BatchSegmentJobOutput jobOutput) The Amazon S3 path for the bucket where the job's output will be stored.numResults
(Integer numResults) The number of predicted users generated by the batch segment job for each line of input data.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.solutionVersionArn
(String solutionVersionArn) The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.tags
(Collection<Tag> tags) A list of tags to apply to the batch segment job.tags
(Consumer<Tag.Builder>... tags) A list of tags to apply to the batch segment job.A list of tags to apply to the batch segment job.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
The name of the batch segment job to create.
- Parameters:
jobName
- The name of the batch segment job to create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionVersionArn
The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
- Parameters:
solutionVersionArn
- The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filterArn
The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.
- Parameters:
filterArn
- The ARN of the filter to apply to the batch segment 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
The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
- Parameters:
numResults
- The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobInput
The Amazon S3 path for the input data used to generate the batch segment job.
- Parameters:
jobInput
- The Amazon S3 path for the input data used to generate the batch segment job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobInput
default CreateBatchSegmentJobRequest.Builder jobInput(Consumer<BatchSegmentJobInput.Builder> jobInput) The Amazon S3 path for the input data used to generate the batch segment job.
This is a convenience method that creates an instance of theBatchSegmentJobInput.Builder
avoiding the need to create one manually viaBatchSegmentJobInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tojobInput(BatchSegmentJobInput)
.- Parameters:
jobInput
- a consumer that will call methods onBatchSegmentJobInput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
jobOutput
The Amazon S3 path for the bucket where the job's output will be stored.
- Parameters:
jobOutput
- The Amazon S3 path for the 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 CreateBatchSegmentJobRequest.Builder jobOutput(Consumer<BatchSegmentJobOutput.Builder> jobOutput) The Amazon S3 path for the bucket where the job's output will be stored.
This is a convenience method that creates an instance of theBatchSegmentJobOutput.Builder
avoiding the need to create one manually viaBatchSegmentJobOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tojobOutput(BatchSegmentJobOutput)
.- Parameters:
jobOutput
- a consumer that will call methods onBatchSegmentJobOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
tags
A list of tags to apply to the batch segment job.
- Parameters:
tags
- A list of tags to apply to the batch segment job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tags to apply to the batch segment job.
- Parameters:
tags
- A list of tags to apply to the batch segment job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tags to apply to the batch segment job.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateBatchSegmentJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateBatchSegmentJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-