Class ShardFilter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ShardFilter.Builder,
ShardFilter>
The request parameter used to filter out the response of the ListShards
API.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ShardFilter.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends ShardFilter.Builder> final String
shardId()
The exclusive startshardID
speified in theShardFilter
parameter.final Instant
The timestamps specified in theShardFilter
parameter.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ShardFilterType
type()
The shard type specified in theShardFilter
parameter.final String
The shard type specified in theShardFilter
parameter.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The shard type specified in the
ShardFilter
parameter. This is a required property of theShardFilter
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 theShardId
that you provided. -
AT_TRIM_HORIZON
- the response includes all the shards that were open atTRIM_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 toTRIM_HORIZON
of the data stream ifFROM_TIMESTAMP
is less than theTRIM_HORIZON
value.
If the service returns an enum value that is not available in the current SDK version,
type
will returnShardFilterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The shard type specified in the
ShardFilter
parameter. This is a required property of theShardFilter
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 theShardId
that you provided. -
AT_TRIM_HORIZON
- the response includes all the shards that were open atTRIM_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 toTRIM_HORIZON
of the data stream ifFROM_TIMESTAMP
is less than theTRIM_HORIZON
value.
-
- See Also:
-
-
typeAsString
The shard type specified in the
ShardFilter
parameter. This is a required property of theShardFilter
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 theShardId
that you provided. -
AT_TRIM_HORIZON
- the response includes all the shards that were open atTRIM_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 toTRIM_HORIZON
of the data stream ifFROM_TIMESTAMP
is less than theTRIM_HORIZON
value.
If the service returns an enum value that is not available in the current SDK version,
type
will returnShardFilterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The shard type specified in the
ShardFilter
parameter. This is a required property of theShardFilter
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 theShardId
that you provided. -
AT_TRIM_HORIZON
- the response includes all the shards that were open atTRIM_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 toTRIM_HORIZON
of the data stream ifFROM_TIMESTAMP
is less than theTRIM_HORIZON
value.
-
- See Also:
-
-
shardId
The exclusive start
shardID
speified in theShardFilter
parameter. This property can only be used if theAFTER_SHARD_ID
shard type is specified.- Returns:
- The exclusive start
shardID
speified in theShardFilter
parameter. This property can only be used if theAFTER_SHARD_ID
shard type is specified.
-
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 ifFROM_TIMESTAMP
orAT_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 ifFROM_TIMESTAMP
orAT_TIMESTAMP
shard types are specified.
-
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 interfaceToCopyableBuilder<ShardFilter.Builder,
ShardFilter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-