Package com.google.firestore.admin.v1

Enum Index.QueryScope

java.lang.Object
java.lang.Enum<Index.QueryScope>
com.google.firestore.admin.v1.Index.QueryScope
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Index.QueryScope>
Enclosing class:
Index
public static enum Index.QueryScope extends Enum<Index.QueryScope> implements com.google.protobuf.ProtocolMessageEnum
 Query Scope defines the scope at which a query is run. This is specified on
 a StructuredQuery's `from` field.
Protobuf enum google.firestore.admin.v1.Index.QueryScope

  • Enum Constant Details

    • QUERY_SCOPE_UNSPECIFIED

      public static final Index.QueryScope QUERY_SCOPE_UNSPECIFIED
       The query scope is unspecified. Not a valid option.
      QUERY_SCOPE_UNSPECIFIED = 0;

    • COLLECTION

      public static final Index.QueryScope COLLECTION
       Indexes with a collection query scope specified allow queries
 against a collection that is the child of a specific document, specified
 at query time, and that has the collection ID specified by the index.
      COLLECTION = 1;

    • COLLECTION_GROUP

      public static final Index.QueryScope COLLECTION_GROUP
       Indexes with a collection group query scope specified allow queries
 against all collections that has the collection ID specified by the
 index.
      COLLECTION_GROUP = 2;

    • COLLECTION_RECURSIVE

      public static final Index.QueryScope COLLECTION_RECURSIVE
       Include all the collections's ancestor in the index. Only available for
 Datastore Mode databases.
      COLLECTION_RECURSIVE = 3;

    • UNRECOGNIZED

      public static final Index.QueryScope UNRECOGNIZED

  • Field Details

    • QUERY_SCOPE_UNSPECIFIED_VALUE

      public static final int QUERY_SCOPE_UNSPECIFIED_VALUE
       The query scope is unspecified. Not a valid option.
      QUERY_SCOPE_UNSPECIFIED = 0;
      See Also:

    • COLLECTION_VALUE

      public static final int COLLECTION_VALUE
       Indexes with a collection query scope specified allow queries
 against a collection that is the child of a specific document, specified
 at query time, and that has the collection ID specified by the index.
      COLLECTION = 1;
      See Also:

    • COLLECTION_GROUP_VALUE

      public static final int COLLECTION_GROUP_VALUE
       Indexes with a collection group query scope specified allow queries
 against all collections that has the collection ID specified by the
 index.
      COLLECTION_GROUP = 2;
      See Also:

    • COLLECTION_RECURSIVE_VALUE

      public static final int COLLECTION_RECURSIVE_VALUE
       Include all the collections's ancestor in the index. Only available for
 Datastore Mode databases.
      COLLECTION_RECURSIVE = 3;
      See Also:

  • Method Details

    • values

      public static Index.QueryScope[] 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 Index.QueryScope 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

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static Index.QueryScope valueOf(int value)
      Deprecated.
      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:
      value - 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

    • forNumber

      public static Index.QueryScope forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<Index.QueryScope> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static Index.QueryScope valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      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:
      desc - 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