Package com.google.firestore.admin.v1

Enum RealtimeUpdatesMode

java.lang.Object
java.lang.Enum<RealtimeUpdatesMode>
com.google.firestore.admin.v1.RealtimeUpdatesMode
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<RealtimeUpdatesMode>
@Generated public enum RealtimeUpdatesMode extends Enum<RealtimeUpdatesMode> implements com.google.protobuf.ProtocolMessageEnum
 The Realtime Updates mode.
Protobuf enum google.firestore.admin.v1.RealtimeUpdatesMode

  • Enum Constant Details

    • REALTIME_UPDATES_MODE_UNSPECIFIED

      public static final RealtimeUpdatesMode REALTIME_UPDATES_MODE_UNSPECIFIED
       The Realtime Updates feature is not specified.
      REALTIME_UPDATES_MODE_UNSPECIFIED = 0;

    • REALTIME_UPDATES_MODE_ENABLED

      public static final RealtimeUpdatesMode REALTIME_UPDATES_MODE_ENABLED
       The Realtime Updates feature is enabled by default.

 This could potentially degrade write performance for the database.
      REALTIME_UPDATES_MODE_ENABLED = 1;

    • REALTIME_UPDATES_MODE_DISABLED

      public static final RealtimeUpdatesMode REALTIME_UPDATES_MODE_DISABLED
       The Realtime Updates feature is disabled by default.
      REALTIME_UPDATES_MODE_DISABLED = 2;

    • UNRECOGNIZED

      public static final RealtimeUpdatesMode UNRECOGNIZED

  • Field Details

    • REALTIME_UPDATES_MODE_UNSPECIFIED_VALUE

      public static final int REALTIME_UPDATES_MODE_UNSPECIFIED_VALUE
       The Realtime Updates feature is not specified.
      REALTIME_UPDATES_MODE_UNSPECIFIED = 0;
      See Also:

    • REALTIME_UPDATES_MODE_ENABLED_VALUE

      public static final int REALTIME_UPDATES_MODE_ENABLED_VALUE
       The Realtime Updates feature is enabled by default.

 This could potentially degrade write performance for the database.
      REALTIME_UPDATES_MODE_ENABLED = 1;
      See Also:

    • REALTIME_UPDATES_MODE_DISABLED_VALUE

      public static final int REALTIME_UPDATES_MODE_DISABLED_VALUE
       The Realtime Updates feature is disabled by default.
      REALTIME_UPDATES_MODE_DISABLED = 2;
      See Also:

  • Method Details

    • values

      public static RealtimeUpdatesMode[] 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 RealtimeUpdatesMode 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 RealtimeUpdatesMode 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 RealtimeUpdatesMode 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<RealtimeUpdatesMode> 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 RealtimeUpdatesMode 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