Class GetPrefetchScheduleResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.mediatailor.model.MediaTailorResponse
software.amazon.awssdk.services.mediatailor.model.GetPrefetchScheduleResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetPrefetchScheduleResponse.Builder,GetPrefetchScheduleResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetPrefetchScheduleResponse extends MediaTailorResponse implements ToCopyableBuilder<GetPrefetchScheduleResponse.Builder,GetPrefetchScheduleResponse>

  • Method Details

    • arn

      public final String arn()

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

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

    • consumption

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

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

    • name

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

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

    • playbackConfigurationName

      public final String playbackConfigurationName()

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

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

    • retrieval

      public final PrefetchRetrieval retrieval()

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

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

    • scheduleType

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

      If the service returns an enum value that is not available in the current SDK version, scheduleType will return PrefetchScheduleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduleTypeAsString().

      Returns:
      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.
      See Also:

    • scheduleTypeAsString

      public final String scheduleTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, scheduleType will return PrefetchScheduleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduleTypeAsString().

      Returns:
      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.
      See Also:

    • recurringPrefetchConfiguration

      public final RecurringPrefetchConfiguration recurringPrefetchConfiguration()

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

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

    • streamId

      public final String streamId()

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

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

    • toBuilder

      public GetPrefetchScheduleResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetPrefetchScheduleResponse.Builder,GetPrefetchScheduleResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetPrefetchScheduleResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetPrefetchScheduleResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.