Package software.amazon.awssdk.services.kinesis.model

Class UpdateShardCountRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kinesis.model.KinesisRequest

software.amazon.awssdk.services.kinesis.model.UpdateShardCountRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateShardCountRequest.Builder,UpdateShardCountRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateShardCountRequest
extends KinesisRequest
implements ToCopyableBuilder<UpdateShardCountRequest.Builder,UpdateShardCountRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateShardCountRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateShardCountRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ScalingType	scalingType()	The scaling type.
String	scalingTypeAsString()	The scaling type.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateShardCountRequest.Builder>	serializableBuilderClass()
String	streamARN()	The ARN of the stream.
String	streamName()	The name of the stream.
Integer	targetShardCount()	The new number of shards.
UpdateShardCountRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

streamName

public final String streamName()

The name of the stream.

Returns:

The name of the stream.

targetShardCount

public final Integer targetShardCount()

The new number of shards. This value has the following default limits. By default, you cannot do the following:

• Set this value to more than double your current shard count for a stream.

• Set this value below half your current shard count for a stream.

• Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.

• Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.

Returns:

The new number of shards. This value has the following default limits. By default, you cannot do the following:

• Set this value to more than double your current shard count for a stream.

• Set this value below half your current shard count for a stream.

• Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.

• Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.

scalingType

public final ScalingType scalingType()

The scaling type. Uniform scaling creates shards of equal size.

If the service returns an enum value that is not available in the current SDK version, scalingType will return ScalingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingTypeAsString().

Returns:

The scaling type. Uniform scaling creates shards of equal size.

See Also:

ScalingType

scalingTypeAsString

public final String scalingTypeAsString()

The scaling type. Uniform scaling creates shards of equal size.

If the service returns an enum value that is not available in the current SDK version, scalingType will return ScalingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingTypeAsString().

Returns:

The scaling type. Uniform scaling creates shards of equal size.

See Also:

ScalingType

streamARN

public final String streamARN()

The ARN of the stream.

Returns:

The ARN of the stream.

toBuilder

public UpdateShardCountRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateShardCountRequest.Builder,UpdateShardCountRequest>

Specified by:

toBuilder in class KinesisRequest

builder

public static UpdateShardCountRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

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