Interface ListFragmentsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListFragmentsRequest.Builder,ListFragmentsRequest>, KinesisVideoArchivedMediaRequest.Builder, SdkBuilder<ListFragmentsRequest.Builder,ListFragmentsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListFragmentsRequest
@Mutable @NotThreadSafe public static interface ListFragmentsRequest.Builder extends KinesisVideoArchivedMediaRequest.Builder, SdkPojo, CopyableBuilder<ListFragmentsRequest.Builder,ListFragmentsRequest>

  • Method Details

    • streamName

      ListFragmentsRequest.Builder streamName(String streamName)

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

      Parameters:
      streamName - The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamARN

      ListFragmentsRequest.Builder streamARN(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListFragmentsRequest.Builder maxResults(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListFragmentsRequest.Builder nextToken(String nextToken)

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

      Parameters:
      nextToken - A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fragmentSelector

      ListFragmentsRequest.Builder fragmentSelector(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • fragmentSelector

      default ListFragmentsRequest.Builder fragmentSelector(Consumer<FragmentSelector.Builder> 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.

      This is a convenience method that creates an instance of the FragmentSelector.Builder avoiding the need to create one manually via FragmentSelector.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fragmentSelector(FragmentSelector).

      Parameters:
      fragmentSelector - a consumer that will call methods on FragmentSelector.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ListFragmentsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListFragmentsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.