Package com.sap.ai.sdk.grounding.model

# Enum Class Right1.ScopeEnum

java.lang.Object
java.lang.Enum<Right1.ScopeEnum>
com.sap.ai.sdk.grounding.model.Right1.ScopeEnum

All Implemented Interfaces:
  `Serializable`, `Comparable<Right1.ScopeEnum>`, `Constable`

Enclosing class:
  `Right1`

public static enum Right1.ScopeEnum extends Enum<Right1.ScopeEnum>
Scope of the metadata filter (e.g., collection, document, chunk)

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `CHUNK`
  The CHUNK option of this Right1
  `COLLECTION`
  The COLLECTION option of this Right1
  `DOCUMENT`
  The DOCUMENT option of this Right1
  `UNKNOWN_DEFAULT_OPEN_API`
  The UNKNOWN_DEFAULT_OPEN_API option of this Right1

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static Right1.ScopeEnum`
  `fromValue(String value)`
  Get the enum value from a String value
  `String`
  `getValue()`
  Get the value of the enum
  `String`
  `toString()`
  Get the String value of the enum value.
  `static Right1.ScopeEnum`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static Right1.ScopeEnum[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

  `clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### COLLECTION

    public static final Right1.ScopeEnum COLLECTION
    The COLLECTION option of this Right1

  - ### DOCUMENT

    public static final Right1.ScopeEnum DOCUMENT
    The DOCUMENT option of this Right1

  - ### CHUNK

    public static final Right1.ScopeEnum CHUNK
    The CHUNK option of this Right1

  - ### UNKNOWN_DEFAULT_OPEN_API

    public static final Right1.ScopeEnum UNKNOWN_DEFAULT_OPEN_API
    The UNKNOWN_DEFAULT_OPEN_API option of this Right1

- ## Method Details

  - ### values

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

  - ### valueOf

    public static Right1.ScopeEnum valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      `NullPointerException` - if the argument is null

  - ### getValue

    @Nonnull public String getValue()
    Get the value of the enum
    Returns:
      The enum value

  - ### toString

    @Nonnull public String toString()
    Get the String value of the enum value.
    Overrides:
      `toString` in class `Enum<Right1.ScopeEnum>`
    Returns:
      The enum value as String

  - ### fromValue

    @Nonnull public static Right1.ScopeEnum fromValue(@Nonnull String value)
    Get the enum value from a String value
    Parameters:
      `value` - The String value
    Returns:
      The enum value of type Right1