Package software.amazon.awssdk.services.kendra.model

Class CapacityUnitsConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.CapacityUnitsConfiguration

All Implemented Interfaces:

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

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

Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CapacityUnitsConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static CapacityUnitsConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	queryCapacityUnits()	The amount of extra query capacity for an index and GetQuerySuggestions capacity.
List<SdkField<?>>	sdkFields()
static Class<? extends CapacityUnitsConfiguration.Builder>	serializableBuilderClass()
Integer	storageCapacityUnits()	The amount of extra storage capacity for an index.
CapacityUnitsConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

storageCapacityUnits

public final Integer storageCapacityUnits()

The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.

Returns:

The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.

queryCapacityUnits

public final Integer queryCapacityUnits()

The amount of extra query capacity for an index and GetQuerySuggestions capacity.

A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.

GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

Returns:

The amount of extra query capacity for an index and GetQuerySuggestions capacity.

A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.

GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

toBuilder

public CapacityUnitsConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CapacityUnitsConfiguration.Builder,CapacityUnitsConfiguration>

builder

public static CapacityUnitsConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends CapacityUnitsConfiguration.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