Interface GetHarvestJobResponse.Builder

  • Method Details

    • channelGroupName

      GetHarvestJobResponse.Builder channelGroupName(String channelGroupName)

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

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

      GetHarvestJobResponse.Builder channelName(String channelName)

      The name of the channel associated with the harvest job.

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

      GetHarvestJobResponse.Builder originEndpointName(String originEndpointName)

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

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

      GetHarvestJobResponse.Builder destination(Destination destination)

      The S3 destination where the harvested content is being placed.

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

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

      The S3 destination where the harvested content is being 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

      GetHarvestJobResponse.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

      GetHarvestJobResponse.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 GetHarvestJobResponse.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

      GetHarvestJobResponse.Builder description(String description)

      The description of the harvest job, if provided.

      Parameters:
      description - The description of the harvest job, if provided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • scheduleConfiguration

      GetHarvestJobResponse.Builder scheduleConfiguration(HarvesterScheduleConfiguration scheduleConfiguration)

      The configuration for when the harvest job is scheduled to run, including start and end times.

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

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

      The configuration for when the harvest job is scheduled to run, including start and end times.

      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

      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

      GetHarvestJobResponse.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

      GetHarvestJobResponse.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

      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

      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

      GetHarvestJobResponse.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

      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.
    • tags

      A collection of tags associated with the harvest job.

      Parameters:
      tags - A collection of tags associated with the harvest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.