Class DescribeStreamRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.kinesis.model.DescribeStreamRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Represents the input for DescribeStream.

See Also:
  • Constructor Details

    • DescribeStreamRequest

      public DescribeStreamRequest()
  • Method Details

    • setStreamName

      public void setStreamName(String streamName)

      The name of the stream to describe.

      Parameters:
      streamName - The name of the stream to describe.
    • getStreamName

      public String getStreamName()

      The name of the stream to describe.

      Returns:
      The name of the stream to describe.
    • withStreamName

      public DescribeStreamRequest withStreamName(String streamName)

      The name of the stream to describe.

      Parameters:
      streamName - The name of the stream to describe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setLimit

      public void setLimit(Integer limit)

      The maximum number of shards to return.

      Parameters:
      limit - The maximum number of shards to return.
    • getLimit

      public Integer getLimit()

      The maximum number of shards to return.

      Returns:
      The maximum number of shards to return.
    • withLimit

      public DescribeStreamRequest withLimit(Integer limit)

      The maximum number of shards to return.

      Parameters:
      limit - The maximum number of shards to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setExclusiveStartShardId

      public void setExclusiveStartShardId(String exclusiveStartShardId)

      The shard ID of the shard to start with.

      Parameters:
      exclusiveStartShardId - The shard ID of the shard to start with.
    • getExclusiveStartShardId

      public String getExclusiveStartShardId()

      The shard ID of the shard to start with.

      Returns:
      The shard ID of the shard to start with.
    • withExclusiveStartShardId

      public DescribeStreamRequest withExclusiveStartShardId(String exclusiveStartShardId)

      The shard ID of the shard to start with.

      Parameters:
      exclusiveStartShardId - The shard ID of the shard to start with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DescribeStreamRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: