@Generated(value="software.amazon.awssdk:codegen") public final class ShardFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ShardFilter.Builder,ShardFilter>
The request parameter used to filter out the response of the ListShards
API.
Modifier and Type | Class and Description |
---|---|
static interface |
ShardFilter.Builder |
Modifier and Type | Method and Description |
---|---|
static ShardFilter.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ShardFilter.Builder> |
serializableBuilderClass() |
String |
shardId()
The exclusive start
shardID speified in the ShardFilter parameter. |
Instant |
timestamp()
The timestamps specified in the
ShardFilter parameter. |
ShardFilter.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
ShardFilterType |
type()
The shard type specified in the
ShardFilter parameter. |
String |
typeAsString()
The shard type specified in the
ShardFilter parameter. |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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.
If the service returns an enum value that is not available in the current SDK version, type
will return
ShardFilterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
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.
ShardFilterType
public final String typeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, type
will return
ShardFilterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
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.
ShardFilterType
public final 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.
shardID
speified in the ShardFilter
parameter. This
property can only be used if the AFTER_SHARD_ID
shard type is specified.public final Instant 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.
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.public ShardFilter.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ShardFilter.Builder,ShardFilter>
public static ShardFilter.Builder builder()
public static Class<? extends ShardFilter.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.