software.amazon.awssdk.services.opensearch.model

Class StorageTypeLimit

java.lang.Object

software.amazon.awssdk.services.opensearch.model.StorageTypeLimit

All Implemented Interfaces:

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

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

Limits that are applicable for the given Amazon OpenSearch Service storage type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StorageTypeLimit.Builder

Method Summary

Modifier and Type	Method and Description
static StorageTypeLimit.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLimitValues() For responses, this returns true if the service returned a value for the LimitValues property.
String	limitName() Name of storage limits that are applicable for the given storage type.
List<String>	limitValues() The limit values.
List<SdkField<?>>	sdkFields()
static Class<? extends StorageTypeLimit.Builder>	serializableBuilderClass()
StorageTypeLimit.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

limitName

public final String limitName()

Name of storage limits that are applicable for the given storage type. If StorageType is ebs, the following options are available:

• MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.

• MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.

• MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.

• MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.

• MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.

• MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.

Returns:

Name of storage limits that are applicable for the given storage type. If StorageType is ebs, the following options are available:

• MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.

• MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.

• MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.

• MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.

• MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.

• MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.

hasLimitValues

public final boolean hasLimitValues()

For responses, this returns true if the service returned a value for the LimitValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

limitValues

public final List<String> limitValues()

The limit values.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLimitValues() method.

Returns:

The limit values.

toBuilder

public StorageTypeLimit.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StorageTypeLimit.Builder,StorageTypeLimit>

builder

public static StorageTypeLimit.Builder builder()

serializableBuilderClass

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