Interface CreateHarvestJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateHarvestJobRequest.Builder,CreateHarvestJobRequest>, MediaPackageV2Request.Builder, SdkBuilder<CreateHarvestJobRequest.Builder,CreateHarvestJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateHarvestJobRequest

@Mutable
@NotThreadSafe
public static interface CreateHarvestJobRequest.Builder
extends MediaPackageV2Request.Builder, SdkPojo, CopyableBuilder<CreateHarvestJobRequest.Builder,CreateHarvestJobRequest>

Method Summary

Modifier and Type	Method	Description
CreateHarvestJobRequest.Builder	channelGroupName(String channelGroupName)	The name of the channel group containing the channel from which to harvest content.
CreateHarvestJobRequest.Builder	channelName(String channelName)	The name of the channel from which to harvest content.
CreateHarvestJobRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateHarvestJobRequest.Builder	description(String description)	An optional description for the harvest job.
default CreateHarvestJobRequest.Builder	destination(Consumer<Destination.Builder> destination)	The S3 destination where the harvested content will be placed.
CreateHarvestJobRequest.Builder	destination(Destination destination)	The S3 destination where the harvested content will be placed.
default CreateHarvestJobRequest.Builder	harvestedManifests(Consumer<HarvestedManifests.Builder> harvestedManifests)	A list of manifests to be harvested.
CreateHarvestJobRequest.Builder	harvestedManifests(HarvestedManifests harvestedManifests)	A list of manifests to be harvested.
CreateHarvestJobRequest.Builder	harvestJobName(String harvestJobName)	A name for the harvest job.
CreateHarvestJobRequest.Builder	originEndpointName(String originEndpointName)	The name of the origin endpoint from which to harvest content.
CreateHarvestJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateHarvestJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateHarvestJobRequest.Builder	scheduleConfiguration(Consumer<HarvesterScheduleConfiguration.Builder> scheduleConfiguration)	The configuration for when the harvest job should run, including start and end times.
CreateHarvestJobRequest.Builder	scheduleConfiguration(HarvesterScheduleConfiguration scheduleConfiguration)	The configuration for when the harvest job should run, including start and end times.
CreateHarvestJobRequest.Builder	tags(Map<String,String> tags)	A collection of tags associated with the harvest job.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.mediapackagev2.model.MediaPackageV2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

channelGroupName

CreateHarvestJobRequest.Builder channelGroupName(String channelGroupName)

The name of the channel group containing the channel from which to harvest content.

Parameters:

channelGroupName - The name of the channel group containing the channel from which to harvest content.

Returns:

Returns a reference to this object so that method calls can be chained together.

channelName

CreateHarvestJobRequest.Builder channelName(String channelName)

The name of the channel from which to harvest content.

Parameters:

channelName - The name of the channel from which to harvest content.

Returns:

Returns a reference to this object so that method calls can be chained together.

originEndpointName

CreateHarvestJobRequest.Builder originEndpointName(String originEndpointName)

The name of the origin endpoint from which to harvest content.

Parameters:

originEndpointName - The name of the origin endpoint from which to harvest content.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateHarvestJobRequest.Builder description(String description)

An optional description for the harvest job.

Parameters:

description - An optional description for the harvest job.

Returns:

Returns a reference to this object so that method calls can be chained together.

harvestedManifests

CreateHarvestJobRequest.Builder harvestedManifests(HarvestedManifests harvestedManifests)

A list of manifests to be harvested.

Parameters:

harvestedManifests - A list of manifests to be harvested.

Returns:

Returns a reference to this object so that method calls can be chained together.

harvestedManifests

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

A list of manifests to 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:

• harvestedManifests(HarvestedManifests)

scheduleConfiguration

CreateHarvestJobRequest.Builder scheduleConfiguration(HarvesterScheduleConfiguration scheduleConfiguration)

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

Parameters:

scheduleConfiguration - The configuration for when the harvest job should run, including start and end times.

Returns:

Returns a reference to this object so that method calls can be chained together.

scheduleConfiguration

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

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

• scheduleConfiguration(HarvesterScheduleConfiguration)

destination

CreateHarvestJobRequest.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 CreateHarvestJobRequest.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:

• destination(Destination)

clientToken

CreateHarvestJobRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

harvestJobName

CreateHarvestJobRequest.Builder harvestJobName(String harvestJobName)

A name for the harvest job. This name must be unique within the channel.

Parameters:

harvestJobName - A name for the harvest job. This name must be unique within the channel.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

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

overrideConfiguration

CreateHarvestJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateHarvestJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.