Package software.amazon.awssdk.services.dynamodb.model

Class ShardFilter

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.ShardFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ShardFilter.Builder,ShardFilter>

@Generated("software.amazon.awssdk:codegen")
public final class ShardFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ShardFilter.Builder,ShardFilter>

This optional field contains the filter definition for the DescribeStream API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShardFilter.Builder

Method Summary

Modifier and Type	Method	Description
static ShardFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ShardFilter.Builder>	serializableBuilderClass()
String	shardId()	Contains the shardId of the parent shard for which you are requesting child shards.
ShardFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ShardFilterType	type()	Contains the type of filter to be applied on the DescribeStream API.
String	typeAsString()	Contains the type of filter to be applied on the DescribeStream API.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

type

public final ShardFilterType type()

Contains the type of filter to be applied on the DescribeStream API. Currently, the only value this parameter accepts is CHILD_SHARDS.

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().

Returns:

Contains the type of filter to be applied on the DescribeStream API. Currently, the only value this parameter accepts is CHILD_SHARDS.

See Also:

ShardFilterType

typeAsString

public final String typeAsString()

Contains the type of filter to be applied on the DescribeStream API. Currently, the only value this parameter accepts is CHILD_SHARDS.

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().

Returns:

Contains the type of filter to be applied on the DescribeStream API. Currently, the only value this parameter accepts is CHILD_SHARDS.

See Also:

ShardFilterType

shardId

public final String shardId()

Contains the shardId of the parent shard for which you are requesting child shards.

Sample request:

Returns:

Contains the shardId of the parent shard for which you are requesting child shards.

Sample request:

toBuilder

public ShardFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ShardFilter.Builder,ShardFilter>

builder

public static ShardFilter.Builder builder()

serializableBuilderClass

public static Class<? extends ShardFilter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo