Package software.amazon.awssdk.services.opensearch.model

Class InstanceTypeDetails

java.lang.Object
software.amazon.awssdk.services.opensearch.model.InstanceTypeDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceTypeDetails.Builder,InstanceTypeDetails>
@Generated("software.amazon.awssdk:codegen") public final class InstanceTypeDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceTypeDetails.Builder,InstanceTypeDetails>

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

See Also:

  • Method Details

    • instanceType

      public final OpenSearchPartitionInstanceType instanceType()

      The instance type.

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

      Returns:
      The instance type.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The instance type.

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

      Returns:
      The instance type.
      See Also:

    • encryptionEnabled

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

      public final Boolean cognitoEnabled()

      Whether Amazon Cognito access is supported for the instance type.

      Returns:
      Whether Amazon Cognito access is supported for the instance type.

    • appLogsEnabled

      public final Boolean appLogsEnabled()

      Whether logging is supported for the instance type.

      Returns:
      Whether logging is supported for the instance type.

    • advancedSecurityEnabled

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

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

    • instanceRole

      public final List<String> 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 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.

    • availabilityZones

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

      public InstanceTypeDetails.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<InstanceTypeDetails.Builder,InstanceTypeDetails>

    • builder

      public static InstanceTypeDetails.Builder builder()

    • serializableBuilderClass

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