Package software.amazon.awssdk.services.kinesis.model

Class ListChannelsRequest

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

  • Method Details

    • hasStreamFilter

      public final boolean hasStreamFilter()
      For responses, this returns true if the service returned a value for the StreamFilter property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • streamFilter

      public final List<StreamFilter> streamFilter()

      Filters the results to channels associated with the specified streams.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStreamFilter() method.

      Returns:
      Filters the results to channels associated with the specified streams.

    • maxResults

      public final Integer maxResults()

      The maximum number of channels to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

      Returns:
      The maximum number of channels to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

    • nextToken

      public final String nextToken()

      The pagination token returned by a previous call. Specify this token to retrieve the next page of results. This value is null when there are no more results to return.

      Returns:
      The pagination token returned by a previous call. Specify this token to retrieve the next page of results. This value is null when there are no more results to return.

    • toBuilder

      public ListChannelsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListChannelsRequest.Builder,ListChannelsRequest>
      Specified by:
      toBuilder in class KinesisRequest

    • builder

      public static ListChannelsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListChannelsRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo