Enum DomainUseCase

java.lang.Object
java.lang.Enum<DomainUseCase>
software.amazon.awssdk.services.opensearch.model.DomainUseCase
All Implemented Interfaces:
Serializable, Comparable<DomainUseCase>
@Generated("software.amazon.awssdk:codegen") public enum DomainUseCase extends Enum<DomainUseCase>

The primary use case for the domain, which determines the default configuration and the engine modes that are available. Valid values are SEARCH (full-text search, e-commerce, content discovery, and hybrid and semantic search), VECTOR (k-NN and semantic search, and retrieval-augmented generation), OBSERVABILITY (logs, metrics, traces, and dashboards), and MIXED (a combination of search and analytics). If you don't specify a use case, MIXED is used.

  • Enum Constant Details

  • Method Details

    • values

      public static DomainUseCase[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static DomainUseCase valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<DomainUseCase>

    • fromValue

      public static DomainUseCase fromValue(String value)
      Use this in place of valueOf to convert the raw string returned by the service into the enum value.
      Parameters:
      value - real value
      Returns:
      DomainUseCase corresponding to the value

    • knownValues

      public static Set<DomainUseCase> knownValues()
      Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.
      Returns:
      a Set of known DomainUseCases