software.amazon.awssdk.services.mediatailor.model

Interface PrefetchRetrieval.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PrefetchRetrieval.Builder,PrefetchRetrieval>, SdkBuilder<PrefetchRetrieval.Builder,PrefetchRetrieval>, SdkPojo

Enclosing class:

PrefetchRetrieval

public static interface PrefetchRetrieval.Builder
extends SdkPojo, CopyableBuilder<PrefetchRetrieval.Builder,PrefetchRetrieval>

Method Summary

Modifier and Type	Method and Description
PrefetchRetrieval.Builder	dynamicVariables(Map<String,String> dynamicVariables) The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
PrefetchRetrieval.Builder	endTime(Instant endTime) The time when prefetch retrieval ends for the ad break.
PrefetchRetrieval.Builder	startTime(Instant startTime) The time when prefetch retrievals can start for this break.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

dynamicVariables

PrefetchRetrieval.Builder dynamicVariables(Map<String,String> dynamicVariables)

The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

Parameters:

dynamicVariables - The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

Returns:

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

endTime

PrefetchRetrieval.Builder endTime(Instant endTime)

The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

Parameters:

endTime - The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

Returns:

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

startTime

PrefetchRetrieval.Builder startTime(Instant startTime)

The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

Parameters:

startTime - The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

Returns:

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