Interface CreatePrefetchScheduleRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreatePrefetchScheduleRequest.Builder,CreatePrefetchScheduleRequest>, MediaTailorRequest.Builder, SdkBuilder<CreatePrefetchScheduleRequest.Builder,CreatePrefetchScheduleRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreatePrefetchScheduleRequest
public static interface CreatePrefetchScheduleRequest.Builder extends MediaTailorRequest.Builder, SdkPojo, CopyableBuilder<CreatePrefetchScheduleRequest.Builder,CreatePrefetchScheduleRequest>

  • Method Details

    • consumption

      CreatePrefetchScheduleRequest.Builder consumption(PrefetchConsumption consumption)

      The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. 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 MediaTailor's consumption of the prefetched ads from the ad decision server. 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 CreatePrefetchScheduleRequest.Builder consumption(Consumer<PrefetchConsumption.Builder> consumption)

      The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. 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

      CreatePrefetchScheduleRequest.Builder name(String name)

      The name to assign to the schedule request.

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

    • playbackConfigurationName

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

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

    • streamId

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

    • overrideConfiguration

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

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