Interface CreatePrefetchScheduleResponse.Builder

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

  • Method Details

    • arn

      CreatePrefetchScheduleResponse.Builder arn(String arn)

      The ARN to assign to the prefetch schedule.

      Parameters:
      arn - The ARN to assign to the prefetch schedule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • consumption

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

      CreatePrefetchScheduleResponse.Builder name(String name)

      The name to assign to the prefetch schedule.

      Parameters:
      name - The name to assign to the prefetch schedule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • playbackConfigurationName

      CreatePrefetchScheduleResponse.Builder playbackConfigurationName(String playbackConfigurationName)

      The name to assign to the playback configuration.

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

    • retrieval

      CreatePrefetchScheduleResponse.Builder retrieval(PrefetchRetrieval retrieval)

      The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

      Parameters:
      retrieval - The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retrieval

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

      The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

      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:

    • recurringPrefetchConfiguration

      CreatePrefetchScheduleResponse.Builder recurringPrefetchConfiguration(RecurringPrefetchConfiguration recurringPrefetchConfiguration)

      The configuration that defines how MediaTailor performs recurring prefetch.

      Parameters:
      recurringPrefetchConfiguration - The configuration that defines how MediaTailor performs recurring prefetch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recurringPrefetchConfiguration

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

      The configuration that defines how MediaTailor performs recurring prefetch.

      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:

    • scheduleType

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

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

    • streamId

      CreatePrefetchScheduleResponse.Builder streamId(String streamId)

      An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

      Parameters:
      streamId - An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.
      Returns:
      Returns a reference to this object so that method calls can be chained together.