Class CreatePrefetchScheduleResponse

    • Method Detail

      • arn

        public final String arn()

        The ARN to assign to the prefetch schedule.

        Returns:
        The ARN to assign to the prefetch schedule.
      • consumption

        public final 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.

        Returns:
        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.
      • name

        public final String name()

        The name to assign to the prefetch schedule.

        Returns:
        The name to assign to the prefetch schedule.
      • playbackConfigurationName

        public final String playbackConfigurationName()

        The name to assign to the playback configuration.

        Returns:
        The name to assign to the playback configuration.
      • retrieval

        public final 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.

        Returns:
        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.
      • streamId

        public final 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.

        Returns:
        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.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object