Class ListFragmentsRequest

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

  • Method Details

    • streamName

      public final String streamName()

      The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.

      Returns:
      The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.

    • streamARN

      public final String streamARN()

      The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

      Returns:
      The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

    • maxResults

      public final Long maxResults()

      The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

      Returns:
      The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

    • nextToken

      public final String nextToken()

      A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

      Returns:
      A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

    • fragmentSelector

      public final FragmentSelector fragmentSelector()

      Describes the timestamp range and timestamp origin for the range of fragments to return.

      This is only required when the NextToken isn't passed in the API.

      Returns:
      Describes the timestamp range and timestamp origin for the range of fragments to return.

      This is only required when the NextToken isn't passed in the API.

    • toBuilder

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

    • builder

      public static ListFragmentsRequest.Builder builder()

    • serializableBuilderClass

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