Interface GetPrefetchScheduleResponse.Builder

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

  • Method Details

    • arn

      GetPrefetchScheduleResponse.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the prefetch schedule.

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

    • consumption

      GetPrefetchScheduleResponse.Builder consumption(PrefetchConsumption consumption)

      The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

      Parameters:
      consumption - The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • consumption

      default GetPrefetchScheduleResponse.Builder consumption(Consumer<PrefetchConsumption.Builder> consumption)

      The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

      This is a convenience method that creates an instance of the PrefetchConsumption.Builder avoiding the need to create one manually via PrefetchConsumption.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to consumption(PrefetchConsumption).

      Parameters:
      consumption - a consumer that will call methods on PrefetchConsumption.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      GetPrefetchScheduleResponse.Builder name(String name)

      The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

      Parameters:
      name - The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • playbackConfigurationName

      GetPrefetchScheduleResponse.Builder playbackConfigurationName(String playbackConfigurationName)

      The name of the playback configuration to create the prefetch schedule for.

      Parameters:
      playbackConfigurationName - The name of the playback configuration to create the prefetch schedule for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retrieval

      GetPrefetchScheduleResponse.Builder retrieval(PrefetchRetrieval retrieval)

      A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

      Parameters:
      retrieval - A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retrieval

      default GetPrefetchScheduleResponse.Builder retrieval(Consumer<PrefetchRetrieval.Builder> retrieval)

      A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

      This is a convenience method that creates an instance of the PrefetchRetrieval.Builder avoiding the need to create one manually via PrefetchRetrieval.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retrieval(PrefetchRetrieval).

      Parameters:
      retrieval - a consumer that will call methods on PrefetchRetrieval.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scheduleType

      GetPrefetchScheduleResponse.Builder scheduleType(String scheduleType)

      The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

      Parameters:
      scheduleType - The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scheduleType

      GetPrefetchScheduleResponse.Builder scheduleType(PrefetchScheduleType scheduleType)

      The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

      Parameters:
      scheduleType - The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • recurringPrefetchConfiguration

      GetPrefetchScheduleResponse.Builder recurringPrefetchConfiguration(RecurringPrefetchConfiguration recurringPrefetchConfiguration)

      The configuration that defines how and when MediaTailor performs ad prefetching in a live event.

      Parameters:
      recurringPrefetchConfiguration - The configuration that defines how and when MediaTailor performs ad prefetching in a live event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recurringPrefetchConfiguration

      default GetPrefetchScheduleResponse.Builder recurringPrefetchConfiguration(Consumer<RecurringPrefetchConfiguration.Builder> recurringPrefetchConfiguration)

      The configuration that defines how and when MediaTailor performs ad prefetching in a live event.

      This is a convenience method that creates an instance of the RecurringPrefetchConfiguration.Builder avoiding the need to create one manually via RecurringPrefetchConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recurringPrefetchConfiguration(RecurringPrefetchConfiguration).

      Parameters:
      recurringPrefetchConfiguration - a consumer that will call methods on RecurringPrefetchConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamId

      GetPrefetchScheduleResponse.Builder streamId(String streamId)

      An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

      Parameters:
      streamId - An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.