Interface ShardFilter.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<ShardFilter.Builder,ShardFilter>
,SdkBuilder<ShardFilter.Builder,ShardFilter>
,SdkPojo
- Enclosing class:
- ShardFilter
public static interface ShardFilter.Builder extends SdkPojo, CopyableBuilder<ShardFilter.Builder,ShardFilter>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ShardFilter.Builder
shardId(String shardId)
The exclusive startshardID
speified in theShardFilter
parameter.ShardFilter.Builder
timestamp(Instant timestamp)
The timestamps specified in theShardFilter
parameter.ShardFilter.Builder
type(String type)
The shard type specified in theShardFilter
parameter.ShardFilter.Builder
type(ShardFilterType type)
The shard type specified in theShardFilter
parameter.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
type
ShardFilter.Builder type(String 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.
- Parameters:
type
- The shard type specified in theShardFilter
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ShardFilterType
,ShardFilterType
-
-
type
ShardFilter.Builder type(ShardFilterType 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.
- Parameters:
type
- The shard type specified in theShardFilter
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ShardFilterType
,ShardFilterType
-
-
shardId
ShardFilter.Builder shardId(String shardId)
The exclusive start
shardID
speified in theShardFilter
parameter. This property can only be used if theAFTER_SHARD_ID
shard type is specified.- Parameters:
shardId
- The exclusive startshardID
speified in theShardFilter
parameter. This property can only be used if theAFTER_SHARD_ID
shard type is specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timestamp
ShardFilter.Builder timestamp(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 ifFROM_TIMESTAMP
orAT_TIMESTAMP
shard types are specified.- Parameters:
timestamp
- The timestamps specified in theShardFilter
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:
- Returns a reference to this object so that method calls can be chained together.
-
-