Package com.google.firestore.admin.v1

Enum Field.TtlConfig.State

java.lang.Object
java.lang.Enum<Field.TtlConfig.State>
com.google.firestore.admin.v1.Field.TtlConfig.State
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Field.TtlConfig.State>
Enclosing class:
Field.TtlConfig
public static enum Field.TtlConfig.State extends Enum<Field.TtlConfig.State> implements com.google.protobuf.ProtocolMessageEnum
 The state of applying the TTL configuration to all documents.
Protobuf enum google.firestore.admin.v1.Field.TtlConfig.State

  • Enum Constant Details

    • STATE_UNSPECIFIED

      public static final Field.TtlConfig.State STATE_UNSPECIFIED
       The state is unspecified or unknown.
      STATE_UNSPECIFIED = 0;

    • CREATING

      public static final Field.TtlConfig.State CREATING
       The TTL is being applied. There is an active long-running operation to
 track the change. Newly written documents will have TTLs applied as
 requested. Requested TTLs on existing documents are still being
 processed. When TTLs on all existing documents have been processed, the
 state will move to 'ACTIVE'.
      CREATING = 1;

    • ACTIVE

      public static final Field.TtlConfig.State ACTIVE
       The TTL is active for all documents.
      ACTIVE = 2;

    • NEEDS_REPAIR

      public static final Field.TtlConfig.State NEEDS_REPAIR
       The TTL configuration could not be enabled for all existing documents.
 Newly written documents will continue to have their TTL applied.
 The LRO returned when last attempting to enable TTL for this `Field`
 has failed, and may have more details.
      NEEDS_REPAIR = 3;

    • UNRECOGNIZED

      public static final Field.TtlConfig.State UNRECOGNIZED

  • Field Details

    • STATE_UNSPECIFIED_VALUE

      public static final int STATE_UNSPECIFIED_VALUE
       The state is unspecified or unknown.
      STATE_UNSPECIFIED = 0;
      See Also:

    • CREATING_VALUE

      public static final int CREATING_VALUE
       The TTL is being applied. There is an active long-running operation to
 track the change. Newly written documents will have TTLs applied as
 requested. Requested TTLs on existing documents are still being
 processed. When TTLs on all existing documents have been processed, the
 state will move to 'ACTIVE'.
      CREATING = 1;
      See Also:

    • ACTIVE_VALUE

      public static final int ACTIVE_VALUE
       The TTL is active for all documents.
      ACTIVE = 2;
      See Also:

    • NEEDS_REPAIR_VALUE

      public static final int NEEDS_REPAIR_VALUE
       The TTL configuration could not be enabled for all existing documents.
 Newly written documents will continue to have their TTL applied.
 The LRO returned when last attempting to enable TTL for this `Field`
 has failed, and may have more details.
      NEEDS_REPAIR = 3;
      See Also:

  • Method Details

    • values

      public static Field.TtlConfig.State[] 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 Field.TtlConfig.State 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 Field.TtlConfig.State 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 Field.TtlConfig.State 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<Field.TtlConfig.State> 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 Field.TtlConfig.State 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