ListTagsForStreamRequest (AWS Java SDK for Amazon Kinesis 1.9.20.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kinesis.model.ListTagsForStreamRequest

All Implemented Interfaces:

Serializable
```
public class ListTagsForStreamRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the ListTagsForStream operation.
Lists the tags for the specified Amazon Kinesis stream.

See Also:
AmazonKinesis.listTagsForStream(ListTagsForStreamRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

ListTagsForStreamRequest()

Constructors
Constructor and Description
`ListTagsForStreamRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getExclusiveStartTagKey()` The key to use as the starting point for the list of tags.
`Integer`	`getLimit()` The number of tags to return.
`String`	`getStreamName()` The name of the stream.
`int`	`hashCode()`
`void`	`setExclusiveStartTagKey(String exclusiveStartTagKey)` The key to use as the starting point for the list of tags.
`void`	`setLimit(Integer limit)` The number of tags to return.
`void`	`setStreamName(String streamName)` The name of the stream.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ListTagsForStreamRequest`	`withExclusiveStartTagKey(String exclusiveStartTagKey)` The key to use as the starting point for the list of tags.
`ListTagsForStreamRequest`	`withLimit(Integer limit)` The number of tags to return.
`ListTagsForStreamRequest`	`withStreamName(String streamName)` The name of the stream.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListTagsForStreamRequest
```
public ListTagsForStreamRequest()
```
- Method Detail
  - getStreamName
```
public String getStreamName()
```
    The name of the stream.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The name of the stream.
  - setStreamName
```
public void setStreamName(String streamName)
```
    The name of the stream.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    streamName - The name of the stream.
  - withStreamName
```
public ListTagsForStreamRequest withStreamName(String streamName)
```
    The name of the stream.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    streamName - The name of the stream.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getExclusiveStartTagKey
```
public String getExclusiveStartTagKey()
```
    The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
    Constraints:
    Length: 1 - 128
    
    Returns:
    The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
  - setExclusiveStartTagKey
```
public void setExclusiveStartTagKey(String exclusiveStartTagKey)
```
    The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
    Constraints:
    Length: 1 - 128
    
    Parameters:
    exclusiveStartTagKey - The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
  - withExclusiveStartTagKey
```
public ListTagsForStreamRequest withExclusiveStartTagKey(String exclusiveStartTagKey)
```
    The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    
    Parameters:
    exclusiveStartTagKey - The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getLimit
```
public Integer getLimit()
```
    The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.
    Constraints:
    Range: 1 - 10
    
    Returns:
    The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.
  - setLimit
```
public void setLimit(Integer limit)
```
    The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.
    Constraints:
    Range: 1 - 10
    
    Parameters:
    limit - The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.
  - withLimit
```
public ListTagsForStreamRequest withLimit(Integer limit)
```
    The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 10
    
    Parameters:
    limit - The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.
    
    Returns:
    A reference to this updated 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:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class ListTagsForStreamRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListTagsForStreamRequest

Method Detail

getStreamName

setStreamName

withStreamName

getExclusiveStartTagKey

setExclusiveStartTagKey

withExclusiveStartTagKey

getLimit

setLimit

withLimit

toString

hashCode

equals