Class InstanceTypeDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InstanceTypeDetails.Builder,
InstanceTypeDetails>
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Whether fine-grained access control is supported for the instance type.final Boolean
Whether logging is supported for the instance type.The supported Availability Zones for the instance type.static InstanceTypeDetails.Builder
builder()
final Boolean
Whether Amazon Cognito access is supported for the instance type.final Boolean
Whether encryption at rest and node-to-node encryption are supported for the instance type.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AvailabilityZones property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceRole property.Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.The instance type.final String
The instance type.static Class
<? extends InstanceTypeDetails.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
Whether UltraWarm is supported for the instance type.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
instanceType
The instance type.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnOpenSearchPartitionInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type.
- See Also:
-
instanceTypeAsString
The instance type.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnOpenSearchPartitionInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type.
- See Also:
-
encryptionEnabled
Whether encryption at rest and node-to-node encryption are supported for the instance type.
- Returns:
- Whether encryption at rest and node-to-node encryption are supported for the instance type.
-
cognitoEnabled
Whether Amazon Cognito access is supported for the instance type.
- Returns:
- Whether Amazon Cognito access is supported for the instance type.
-
appLogsEnabled
Whether logging is supported for the instance type.
- Returns:
- Whether logging is supported for the instance type.
-
advancedSecurityEnabled
Whether fine-grained access control is supported for the instance type.
- Returns:
- Whether fine-grained access control is supported for the instance type.
-
warmEnabled
Whether UltraWarm is supported for the instance type.
- Returns:
- Whether UltraWarm is supported for the instance type.
-
hasInstanceRole
public final boolean hasInstanceRole()For responses, this returns true if the service returned a value for the InstanceRole property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
instanceRole
Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.
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
hasInstanceRole()
method.- Returns:
- Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.
-
hasAvailabilityZones
public final boolean hasAvailabilityZones()For responses, this returns true if the service returned a value for the AvailabilityZones property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
availabilityZones
The supported Availability Zones for the instance type.
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
hasAvailabilityZones()
method.- Returns:
- The supported Availability Zones for the instance type.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<InstanceTypeDetails.Builder,
InstanceTypeDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-