Class ListPrefetchSchedulesRequest

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

  • Method Details

    • maxResults

      public final Integer maxResults()

      The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

      The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

      Returns:
      The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

      The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

    • nextToken

      public final String nextToken()

      Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

      For the first ListPrefetchSchedules request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

      Returns:
      Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

      For the first ListPrefetchSchedules request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

    • playbackConfigurationName

      public final String playbackConfigurationName()

      Retrieves the prefetch schedule(s) for a specific playback configuration.

      Returns:
      Retrieves the prefetch schedule(s) for a specific playback configuration.

    • scheduleType

      public final ListPrefetchScheduleType scheduleType()

      The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.

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

      Returns:
      The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.
      See Also:

    • scheduleTypeAsString

      public final String scheduleTypeAsString()

      The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.

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

      Returns:
      The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.
      See Also:

    • streamId

      public final String streamId()

      An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

      Returns:
      An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

    • toBuilder

      public ListPrefetchSchedulesRequest.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<ListPrefetchSchedulesRequest.Builder,ListPrefetchSchedulesRequest>
      Specified by:
      toBuilder in class MediaTailorRequest
      Returns:
      a builder for type T

    • builder

      public static ListPrefetchSchedulesRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.