Interface HarvestJob.Builder

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

  • Method Details

    • channelGroupName

      HarvestJob.Builder channelGroupName(String channelGroupName)

      The name of the channel group containing the channel associated with this harvest job.

      Parameters:
      channelGroupName - The name of the channel group containing the channel associated with this harvest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelName

      HarvestJob.Builder channelName(String channelName)

      The name of the channel associated with this harvest job.

      Parameters:
      channelName - The name of the channel associated with this harvest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • originEndpointName

      HarvestJob.Builder originEndpointName(String originEndpointName)

      The name of the origin endpoint associated with this harvest job.

      Parameters:
      originEndpointName - The name of the origin endpoint associated with this harvest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      HarvestJob.Builder destination(Destination destination)

      The S3 destination where the harvested content will be placed.

      Parameters:
      destination - The S3 destination where the harvested content will be placed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      default HarvestJob.Builder destination(Consumer<Destination.Builder> destination)

      The S3 destination where the harvested content will be placed.

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

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

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

    • harvestJobName

      HarvestJob.Builder harvestJobName(String harvestJobName)

      The name of the harvest job.

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

    • harvestedManifests

      HarvestJob.Builder harvestedManifests(HarvestedManifests harvestedManifests)

      A list of manifests that are being or have been harvested.

      Parameters:
      harvestedManifests - A list of manifests that are being or have been harvested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • harvestedManifests

      default HarvestJob.Builder harvestedManifests(Consumer<HarvestedManifests.Builder> harvestedManifests)

      A list of manifests that are being or have been harvested.

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

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

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

    • description

      HarvestJob.Builder description(String description)

      An optional description of the harvest job.

      Parameters:
      description - An optional description of the harvest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleConfiguration

      HarvestJob.Builder scheduleConfiguration(HarvesterScheduleConfiguration scheduleConfiguration)

      The configuration for when the harvest job is scheduled to run.

      Parameters:
      scheduleConfiguration - The configuration for when the harvest job is scheduled to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleConfiguration

      default HarvestJob.Builder scheduleConfiguration(Consumer<HarvesterScheduleConfiguration.Builder> scheduleConfiguration)

      The configuration for when the harvest job is scheduled to run.

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

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

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

    • arn

      HarvestJob.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the harvest job.

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

    • createdAt

      HarvestJob.Builder createdAt(Instant createdAt)

      The date and time when the harvest job was created.

      Parameters:
      createdAt - The date and time when the harvest job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modifiedAt

      HarvestJob.Builder modifiedAt(Instant modifiedAt)

      The date and time when the harvest job was last modified.

      Parameters:
      modifiedAt - The date and time when the harvest job was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      HarvestJob.Builder status(String status)

      The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).

      Parameters:
      status - The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      HarvestJob.Builder status(HarvestJobStatus status)

      The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).

      Parameters:
      status - The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • errorMessage

      HarvestJob.Builder errorMessage(String errorMessage)

      An error message if the harvest job encountered any issues.

      Parameters:
      errorMessage - An error message if the harvest job encountered any issues.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eTag

      HarvestJob.Builder eTag(String eTag)

      The current version of the harvest job. Used for concurrency control.

      Parameters:
      eTag - The current version of the harvest job. Used for concurrency control.
      Returns:
      Returns a reference to this object so that method calls can be chained together.