ShardFilter (AWS Java SDK for Amazon Kinesis 1.12.347 API)

java.lang.Object
- com.amazonaws.services.kinesis.model.ShardFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ShardFilter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The request parameter used to filter out the response of the ListShards API.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ShardFilter()

Constructors
Constructor and Description
`ShardFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ShardFilter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getShardId()` The exclusive start `shardID` speified in the `ShardFilter` parameter.
`Date`	`getTimestamp()` The timestamps specified in the `ShardFilter` parameter.
`String`	`getType()` The shard type specified in the `ShardFilter` parameter.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setShardId(String shardId)` The exclusive start `shardID` speified in the `ShardFilter` parameter.
`void`	`setTimestamp(Date timestamp)` The timestamps specified in the `ShardFilter` parameter.
`void`	`setType(String type)` The shard type specified in the `ShardFilter` parameter.
`String`	`toString()` Returns a string representation of this object.
`ShardFilter`	`withShardId(String shardId)` The exclusive start `shardID` speified in the `ShardFilter` parameter.
`ShardFilter`	`withTimestamp(Date timestamp)` The timestamps specified in the `ShardFilter` parameter.
`ShardFilter`	`withType(ShardFilterType type)` The shard type specified in the `ShardFilter` parameter.
`ShardFilter`	`withType(String type)` The shard type specified in the `ShardFilter` parameter.

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

- Constructor Detail
  - ShardFilter
```
public ShardFilter()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    The shard type specified in the ShardFilter parameter. This is a required property of the ShardFilter parameter.
    
    You can specify the following valid values:
    - AFTER_SHARD_ID - the response includes all the shards, starting with the shard whose ID immediately follows the ShardId that you provided.
    - AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.
    - FROM_TRIM_HORIZON - (default), the response includes all the shards within the retention period of the data stream (trim to tip).
    - AT_LATEST - the response includes only the currently open shards of the data stream.
    - AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.
    - FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value.
    Parameters:
    type - The shard type specified in the ShardFilter parameter. This is a required property of the ShardFilter parameter.
    
    You can specify the following valid values:
    
    AFTER_SHARD_ID - the response includes all the shards, starting with the shard whose ID immediately follows the ShardId that you provided.
    
    AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.
    
    FROM_TRIM_HORIZON - (default), the response includes all the shards within the retention period of the data stream (trim to tip).
    
    AT_LATEST - the response includes only the currently open shards of the data stream.
    
    AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.
    
    FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value.
    See Also:
    
    ShardFilterType
  - getType
```
public String getType()
```
    The shard type specified in the ShardFilter parameter. This is a required property of the ShardFilter parameter.
    
    You can specify the following valid values:
    - AFTER_SHARD_ID - the response includes all the shards, starting with the shard whose ID immediately follows the ShardId that you provided.
    - AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.
    - FROM_TRIM_HORIZON - (default), the response includes all the shards within the retention period of the data stream (trim to tip).
    - AT_LATEST - the response includes only the currently open shards of the data stream.
    - AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.
    - FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value.
    Returns:
    The shard type specified in the ShardFilter parameter. This is a required property of the ShardFilter parameter.
    
    You can specify the following valid values:
    
    AFTER_SHARD_ID - the response includes all the shards, starting with the shard whose ID immediately follows the ShardId that you provided.
    
    AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.
    
    FROM_TRIM_HORIZON - (default), the response includes all the shards within the retention period of the data stream (trim to tip).
    
    AT_LATEST - the response includes only the currently open shards of the data stream.
    
    AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.
    
    FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value.
    See Also:
    
    ShardFilterType
  - withType
```
public ShardFilter withType(String type)
```
    The shard type specified in the ShardFilter parameter. This is a required property of the ShardFilter parameter.
    
    You can specify the following valid values:
    - AFTER_SHARD_ID - the response includes all the shards, starting with the shard whose ID immediately follows the ShardId that you provided.
    - AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.
    - FROM_TRIM_HORIZON - (default), the response includes all the shards within the retention period of the data stream (trim to tip).
    - AT_LATEST - the response includes only the currently open shards of the data stream.
    - AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.
    - FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value.
    Parameters:
    type - The shard type specified in the ShardFilter parameter. This is a required property of the ShardFilter parameter.
    
    You can specify the following valid values:
    
    AFTER_SHARD_ID - the response includes all the shards, starting with the shard whose ID immediately follows the ShardId that you provided.
    
    AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.
    
    FROM_TRIM_HORIZON - (default), the response includes all the shards within the retention period of the data stream (trim to tip).
    
    AT_LATEST - the response includes only the currently open shards of the data stream.
    
    AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.
    
    FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ShardFilterType
  - withType
```
public ShardFilter withType(ShardFilterType type)
```
    The shard type specified in the ShardFilter parameter. This is a required property of the ShardFilter parameter.
    
    You can specify the following valid values:
    - AFTER_SHARD_ID - the response includes all the shards, starting with the shard whose ID immediately follows the ShardId that you provided.
    - AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.
    - FROM_TRIM_HORIZON - (default), the response includes all the shards within the retention period of the data stream (trim to tip).
    - AT_LATEST - the response includes only the currently open shards of the data stream.
    - AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.
    - FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value.
    Parameters:
    type - The shard type specified in the ShardFilter parameter. This is a required property of the ShardFilter parameter.
    
    You can specify the following valid values:
    
    AFTER_SHARD_ID - the response includes all the shards, starting with the shard whose ID immediately follows the ShardId that you provided.
    
    AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.
    
    FROM_TRIM_HORIZON - (default), the response includes all the shards within the retention period of the data stream (trim to tip).
    
    AT_LATEST - the response includes only the currently open shards of the data stream.
    
    AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.
    
    FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ShardFilterType
  - setShardId
```
public void setShardId(String shardId)
```
    The exclusive start shardID speified in the ShardFilter parameter. This property can only be used if the AFTER_SHARD_ID shard type is specified.
    
    Parameters:
    
    shardId - The exclusive start shardID speified in the ShardFilter parameter. This property can only be used if the AFTER_SHARD_ID shard type is specified.
  - getShardId
```
public String getShardId()
```
    The exclusive start shardID speified in the ShardFilter parameter. This property can only be used if the AFTER_SHARD_ID shard type is specified.
    
    Returns:
    
    The exclusive start shardID speified in the ShardFilter parameter. This property can only be used if the AFTER_SHARD_ID shard type is specified.
  - withShardId
```
public ShardFilter withShardId(String shardId)
```
    The exclusive start shardID speified in the ShardFilter parameter. This property can only be used if the AFTER_SHARD_ID shard type is specified.
    
    Parameters:
    
    shardId - The exclusive start shardID speified in the ShardFilter parameter. This property can only be used if the AFTER_SHARD_ID shard type is specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimestamp
```
public void setTimestamp(Date timestamp)
```
    The timestamps specified in the ShardFilter parameter. A timestamp is a Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if FROM_TIMESTAMP or AT_TIMESTAMP shard types are specified.
    
    Parameters:
    
    timestamp - The timestamps specified in the ShardFilter parameter. A timestamp is a Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if FROM_TIMESTAMP or AT_TIMESTAMP shard types are specified.
  - getTimestamp
```
public Date getTimestamp()
```
    The timestamps specified in the ShardFilter parameter. A timestamp is a Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if FROM_TIMESTAMP or AT_TIMESTAMP shard types are specified.
    
    Returns:
    
    The timestamps specified in the ShardFilter parameter. A timestamp is a Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if FROM_TIMESTAMP or AT_TIMESTAMP shard types are specified.
  - withTimestamp
```
public ShardFilter withTimestamp(Date timestamp)
```
    The timestamps specified in the ShardFilter parameter. A timestamp is a Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if FROM_TIMESTAMP or AT_TIMESTAMP shard types are specified.
    
    Parameters:
    
    timestamp - The timestamps specified in the ShardFilter parameter. A timestamp is a Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if FROM_TIMESTAMP or AT_TIMESTAMP shard types are specified.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ShardFilter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class ShardFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShardFilter

Method Detail

setType

getType

withType

withType

setShardId

getShardId

withShardId

setTimestamp

getTimestamp

withTimestamp

toString

equals

hashCode

clone

marshall