Package org.opensearch.repositories.azure

Enum LocationMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LocationMode>
    public enum LocationMode
extends java.lang.Enum<LocationMode>
    Specifies the location mode used to decide which location the request should be sent to. The enumeration simulates the semantics of the LocationMode, which is gone in the new SDKv12.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      PRIMARY_ONLY
      Requests should always be sent to the primary location.
      PRIMARY_THEN_SECONDARY
      Requests should always be sent to the primary location first.
      SECONDARY_ONLY
      Requests should always be sent to the secondary location.
      SECONDARY_THEN_PRIMARY
      Requests should always be sent to the secondary location first.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static LocationMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static LocationMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • PRIMARY_ONLY

        public static final LocationMode PRIMARY_ONLY
        Requests should always be sent to the primary location.

      • PRIMARY_THEN_SECONDARY

        public static final LocationMode PRIMARY_THEN_SECONDARY
        Requests should always be sent to the primary location first. If the request fails, it should be sent to the secondary location.

      • SECONDARY_ONLY

        public static final LocationMode SECONDARY_ONLY
        Requests should always be sent to the secondary location.

      • SECONDARY_THEN_PRIMARY

        public static final LocationMode SECONDARY_THEN_PRIMARY
        Requests should always be sent to the secondary location first. If the request fails, it should be sent to the primary location.

    • Method Detail

      • values

        public static LocationMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (LocationMode c : LocationMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static LocationMode valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null