Interface GetHarvestJobResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetHarvestJobResponse.Builder,
,GetHarvestJobResponse> MediaPackageV2Response.Builder
,SdkBuilder<GetHarvestJobResponse.Builder,
,GetHarvestJobResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetHarvestJobResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the harvest job.channelGroupName
(String channelGroupName) The name of the channel group containing the channel associated with the harvest job.channelName
(String channelName) The name of the channel associated with the harvest job.The date and time when the harvest job was created.description
(String description) The description of the harvest job, if provided.default GetHarvestJobResponse.Builder
destination
(Consumer<Destination.Builder> destination) The S3 destination where the harvested content is being placed.destination
(Destination destination) The S3 destination where the harvested content is being placed.errorMessage
(String errorMessage) An error message if the harvest job encountered any issues.The current version of the harvest job.default GetHarvestJobResponse.Builder
harvestedManifests
(Consumer<HarvestedManifests.Builder> harvestedManifests) A list of manifests that are being or have been harvested.harvestedManifests
(HarvestedManifests harvestedManifests) A list of manifests that are being or have been harvested.harvestJobName
(String harvestJobName) The name of the harvest job.modifiedAt
(Instant modifiedAt) The date and time when the harvest job was last modified.originEndpointName
(String originEndpointName) The name of the origin endpoint associated with the harvest job.default GetHarvestJobResponse.Builder
scheduleConfiguration
(Consumer<HarvesterScheduleConfiguration.Builder> scheduleConfiguration) The configuration for when the harvest job is scheduled to run, including start and end times.scheduleConfiguration
(HarvesterScheduleConfiguration scheduleConfiguration) The configuration for when the harvest job is scheduled to run, including start and end times.The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).status
(HarvestJobStatus status) The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).A collection of tags associated with the harvest job.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.mediapackagev2.model.MediaPackageV2Response.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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
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
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
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
The S3 destination where the harvested content is being placed.
This is a convenience method that creates an instance of theDestination.Builder
avoiding the need to create one manually viaDestination.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todestination(Destination)
.- Parameters:
destination
- a consumer that will call methods onDestination.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theHarvestedManifests.Builder
avoiding the need to create one manually viaHarvestedManifests.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toharvestedManifests(HarvestedManifests)
.- Parameters:
harvestedManifests
- a consumer that will call methods onHarvestedManifests.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theHarvesterScheduleConfiguration.Builder
avoiding the need to create one manually viaHarvesterScheduleConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toscheduleConfiguration(HarvesterScheduleConfiguration)
.- Parameters:
scheduleConfiguration
- a consumer that will call methods onHarvesterScheduleConfiguration.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
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
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
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.
-