Interface CreateHarvestJobResponse.Builder

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

  • Method Details

    • channelGroupName

      CreateHarvestJobResponse.Builder channelGroupName(String channelGroupName)

      The name of the channel group containing the channel from which content is being harvested.

      Parameters:
      channelGroupName - The name of the channel group containing the channel from which content is being harvested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelName

      CreateHarvestJobResponse.Builder channelName(String channelName)

      The name of the channel from which content is being harvested.

      Parameters:
      channelName - The name of the channel from which content is being harvested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • originEndpointName

      CreateHarvestJobResponse.Builder originEndpointName(String originEndpointName)

      The name of the origin endpoint from which content is being harvested.

      Parameters:
      originEndpointName - The name of the origin endpoint from which content is being harvested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

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

      CreateHarvestJobResponse.Builder harvestJobName(String harvestJobName)

      The name of the created harvest job.

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

    • harvestedManifests

      CreateHarvestJobResponse.Builder harvestedManifests(HarvestedManifests harvestedManifests)

      A list of manifests that will be harvested.

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

    • harvestedManifests

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

      A list of manifests that will be 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

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

      CreateHarvestJobResponse.Builder scheduleConfiguration(HarvesterScheduleConfiguration scheduleConfiguration)

      The configuration for when the harvest job will run, including start and end times.

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

    • scheduleConfiguration

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

      The configuration for when the harvest job will 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

      CreateHarvestJobResponse.Builder arn(String arn)

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

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

    • createdAt

      CreateHarvestJobResponse.Builder createdAt(Instant createdAt)

      The date and time the harvest job was created.

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

    • modifiedAt

      CreateHarvestJobResponse.Builder modifiedAt(Instant modifiedAt)

      The date and time the harvest job was last modified.

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

    • status

      CreateHarvestJobResponse.Builder status(String status)

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

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

    • status

      CreateHarvestJobResponse.Builder status(HarvestJobStatus status)

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

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

    • errorMessage

      CreateHarvestJobResponse.Builder errorMessage(String errorMessage)

      An error message if the harvest job creation failed.

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

    • eTag

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

    • tags

      CreateHarvestJobResponse.Builder tags(Map<String,String> 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.