Class GetChannelScheduleRequest

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.GetChannelScheduleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetChannelScheduleRequest.Builder,GetChannelScheduleRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetChannelScheduleRequest extends MediaTailorRequest implements ToCopyableBuilder<GetChannelScheduleRequest.Builder,GetChannelScheduleRequest>

  • Method Details

    • channelName

      public final String channelName()

      The name of the channel associated with this Channel Schedule.

      Returns:
      The name of the channel associated with this Channel Schedule.

    • durationMinutes

      public final String durationMinutes()

      The duration in minutes of the channel schedule.

      Returns:
      The duration in minutes of the channel schedule.

    • maxResults

      public final Integer maxResults()

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

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

    • nextToken

      public final String nextToken()

      (Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.

      For the first GetChannelScheduleRequest request, omit this value.

      For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

      If the previous response didn't include a NextToken element, there are no more channel schedules to get.

      Returns:
      (Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.

      For the first GetChannelScheduleRequest request, omit this value.

      For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

      If the previous response didn't include a NextToken element, there are no more channel schedules to get.

    • audience

      public final String audience()

      The single audience for GetChannelScheduleRequest.

      Returns:
      The single audience for GetChannelScheduleRequest.

    • toBuilder

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

    • builder

      public static GetChannelScheduleRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetChannelScheduleRequest.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.