Enum Index.AncestorMode

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Index.AncestorMode>
    Enclosing class:
    Index

    public static enum Index.AncestorMode
    extends Enum<Index.AncestorMode>
    implements com.google.protobuf.ProtocolMessageEnum
     For an ordered index, specifies whether each of the entity's ancestors
     will be included.
     
    Protobuf enum google.datastore.admin.v1.Index.AncestorMode
    • Enum Constant Detail

      • ANCESTOR_MODE_UNSPECIFIED

        public static final Index.AncestorMode ANCESTOR_MODE_UNSPECIFIED
         The ancestor mode is unspecified.
         
        ANCESTOR_MODE_UNSPECIFIED = 0;
      • NONE

        public static final Index.AncestorMode NONE
         Do not include the entity's ancestors in the index.
         
        NONE = 1;
      • ALL_ANCESTORS

        public static final Index.AncestorMode ALL_ANCESTORS
         Include all the entity's ancestors in the index.
         
        ALL_ANCESTORS = 2;
    • Field Detail

      • ANCESTOR_MODE_UNSPECIFIED_VALUE

        public static final int ANCESTOR_MODE_UNSPECIFIED_VALUE
         The ancestor mode is unspecified.
         
        ANCESTOR_MODE_UNSPECIFIED = 0;
        See Also:
        Constant Field Values
      • NONE_VALUE

        public static final int NONE_VALUE
         Do not include the entity's ancestors in the index.
         
        NONE = 1;
        See Also:
        Constant Field Values
      • ALL_ANCESTORS_VALUE

        public static final int ALL_ANCESTORS_VALUE
         Include all the entity's ancestors in the index.
         
        ALL_ANCESTORS = 2;
        See Also:
        Constant Field Values
    • Method Detail

      • values

        public static Index.AncestorMode[] 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 (Index.AncestorMode c : Index.AncestorMode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Index.AncestorMode 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.AncestorMode 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.AncestorMode 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.AncestorMode> 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
      • valueOf

        public static Index.AncestorMode 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