Interface BatchSegmentJob.Builder

All Superinterfaces:
Buildable, CopyableBuilder<BatchSegmentJob.Builder,BatchSegmentJob>, SdkBuilder<BatchSegmentJob.Builder,BatchSegmentJob>, SdkPojo
Enclosing class:
BatchSegmentJob
@Mutable @NotThreadSafe public static interface BatchSegmentJob.Builder extends SdkPojo, CopyableBuilder<BatchSegmentJob.Builder,BatchSegmentJob>

  • Method Details

    • jobName

      BatchSegmentJob.Builder jobName(String jobName)

      The name of the batch segment job.

      Parameters:
      jobName - The name of the batch segment job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • batchSegmentJobArn

      BatchSegmentJob.Builder batchSegmentJobArn(String batchSegmentJobArn)

      The Amazon Resource Name (ARN) of the batch segment job.

      Parameters:
      batchSegmentJobArn - The Amazon Resource Name (ARN) of the batch segment job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterArn

      BatchSegmentJob.Builder filterArn(String filterArn)

      The ARN of the filter used on the batch segment job.

      Parameters:
      filterArn - The ARN of the filter used on the batch segment job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureReason

      BatchSegmentJob.Builder failureReason(String failureReason)

      If the batch segment job failed, the reason for the failure.

      Parameters:
      failureReason - If the batch segment job failed, the reason for the failure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • solutionVersionArn

      BatchSegmentJob.Builder solutionVersionArn(String solutionVersionArn)

      The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

      Parameters:
      solutionVersionArn - The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • numResults

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

      BatchSegmentJob.Builder jobInput(BatchSegmentJobInput jobInput)

      The Amazon S3 path that leads to the input data used to generate the batch segment job.

      Parameters:
      jobInput - The Amazon S3 path that leads to 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 BatchSegmentJob.Builder jobInput(Consumer<BatchSegmentJobInput.Builder> jobInput)

      The Amazon S3 path that leads to the input data used to generate the batch segment job.

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

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

      Parameters:
      jobInput - a consumer that will call methods on BatchSegmentJobInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobOutput

      BatchSegmentJob.Builder jobOutput(BatchSegmentJobOutput jobOutput)

      The Amazon S3 bucket that contains the output data generated by the batch segment job.

      Parameters:
      jobOutput - The Amazon S3 bucket that contains the output data generated by the batch segment job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobOutput

      default BatchSegmentJob.Builder jobOutput(Consumer<BatchSegmentJobOutput.Builder> jobOutput)

      The Amazon S3 bucket that contains the output data generated by the batch segment job.

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

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

      Parameters:
      jobOutput - a consumer that will call methods on BatchSegmentJobOutput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      BatchSegmentJob.Builder roleArn(String roleArn)

      The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.

      Parameters:
      roleArn - The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      BatchSegmentJob.Builder status(String status)

      The status of the batch segment job. The status is one of the following values:

      • PENDING

      • IN PROGRESS

      • ACTIVE

      • CREATE FAILED

      Parameters:
      status - The status of the batch segment job. The status is one of the following values:

      • PENDING

      • IN PROGRESS

      • ACTIVE

      • CREATE FAILED

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

    • creationDateTime

      BatchSegmentJob.Builder creationDateTime(Instant creationDateTime)

      The time at which the batch segment job was created.

      Parameters:
      creationDateTime - The time at which the batch segment job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedDateTime

      BatchSegmentJob.Builder lastUpdatedDateTime(Instant lastUpdatedDateTime)

      The time at which the batch segment job last updated.

      Parameters:
      lastUpdatedDateTime - The time at which the batch segment job last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.