Class ListDeliveryStreamsRequest

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

  • Method Details

    • limit

      public final Integer limit()

      The maximum number of delivery streams to list. The default value is 10.

      Returns:
      The maximum number of delivery streams to list. The default value is 10.

    • deliveryStreamType

      public final DeliveryStreamType deliveryStreamType()

      The delivery stream type. This can be one of the following values:

      • DirectPut: Provider applications access the delivery stream directly.

      • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

      This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.

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

      Returns:
      The delivery stream type. This can be one of the following values:

      • DirectPut: Provider applications access the delivery stream directly.

      • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

      This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.

      See Also:

    • deliveryStreamTypeAsString

      public final String deliveryStreamTypeAsString()

      The delivery stream type. This can be one of the following values:

      • DirectPut: Provider applications access the delivery stream directly.

      • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

      This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.

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

      Returns:
      The delivery stream type. This can be one of the following values:

      • DirectPut: Provider applications access the delivery stream directly.

      • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

      This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.

      See Also:

    • exclusiveStartDeliveryStreamName

      public final String exclusiveStartDeliveryStreamName()

      The list of delivery streams returned by this call to ListDeliveryStreams will start with the delivery stream whose name comes alphabetically immediately after the name you specify in ExclusiveStartDeliveryStreamName.

      Returns:
      The list of delivery streams returned by this call to ListDeliveryStreams will start with the delivery stream whose name comes alphabetically immediately after the name you specify in ExclusiveStartDeliveryStreamName.

    • toBuilder

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

    • builder

      public static ListDeliveryStreamsRequest.Builder builder()

    • serializableBuilderClass

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