Interface HarvestJob.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<HarvestJob.Builder,
,HarvestJob> SdkBuilder<HarvestJob.Builder,
,HarvestJob> SdkPojo
- Enclosing class:
HarvestJob
public static interface HarvestJob.Builder
extends SdkPojo, CopyableBuilder<HarvestJob.Builder,HarvestJob>
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) assigned to the HarvestJob.The ID of the Channel that the HarvestJob will harvest from.The date and time the HarvestJob was submitted.The end of the time-window which will be harvested.The ID of the HarvestJob.originEndpointId
(String originEndpointId) The ID of the OriginEndpoint that the HarvestJob will harvest from.default HarvestJob.Builder
s3Destination
(Consumer<S3Destination.Builder> s3Destination) Sets the value of the S3Destination property for this object.s3Destination
(S3Destination s3Destination) Sets the value of the S3Destination property for this object.The start of the time-window which will be harvested.The current status of the HarvestJob.The current status of the HarvestJob.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
arn
The Amazon Resource Name (ARN) assigned to the HarvestJob.- Parameters:
arn
- The Amazon Resource Name (ARN) assigned to the HarvestJob.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
channelId
The ID of the Channel that the HarvestJob will harvest from.- Parameters:
channelId
- The ID of the Channel that the HarvestJob will harvest from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdAt
The date and time the HarvestJob was submitted.- Parameters:
createdAt
- The date and time the HarvestJob was submitted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
The end of the time-window which will be harvested.- Parameters:
endTime
- The end of the time-window which will be harvested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
id
The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.- Parameters:
id
- The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
originEndpointId
The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.- Parameters:
originEndpointId
- The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Destination
Sets the value of the S3Destination property for this object.- Parameters:
s3Destination
- The new value for the S3Destination property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Destination
Sets the value of the S3Destination property for this object. This is a convenience method that creates an instance of theS3Destination.Builder
avoiding the need to create one manually viaS3Destination.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3Destination(S3Destination)
.- Parameters:
s3Destination
- a consumer that will call methods onS3Destination.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
startTime
The start of the time-window which will be harvested.- Parameters:
startTime
- The start of the time-window which will be harvested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.- Parameters:
status
- The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.- Parameters:
status
- The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-