Package com.google.api

Enum FieldInfo.Format

java.lang.Object
java.lang.Enum<FieldInfo.Format>
com.google.api.FieldInfo.Format
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<FieldInfo.Format>
Enclosing class:
FieldInfo
public static enum FieldInfo.Format extends Enum<FieldInfo.Format> implements com.google.protobuf.ProtocolMessageEnum
 The standard format of a field value. The supported formats are all backed
 by either an RFC defined by the IETF or a Google-defined AIP.
Protobuf enum google.api.FieldInfo.Format

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    FORMAT_UNSPECIFIED
    Default, unspecified value.
    IPV4
    Internet Protocol v4 value as defined by [RFC 791](https://datatracker.ietf.org/doc/html/rfc791).
    IPV4_OR_IPV6
    An IP address in either v4 or v6 format as described by the individual values defined herein.
    IPV6
    Internet Protocol v6 value as defined by [RFC 2460](https://datatracker.ietf.org/doc/html/rfc2460).
    UNRECOGNIZED
     
    UUID4
    Universally Unique Identifier, version 4, value as defined by https://datatracker.ietf.org/doc/html/rfc4122.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FORMAT_UNSPECIFIED_VALUE
    Default, unspecified value.
    static final int
    IPV4_OR_IPV6_VALUE
    An IP address in either v4 or v6 format as described by the individual values defined herein.
    static final int
    IPV4_VALUE
    Internet Protocol v4 value as defined by [RFC 791](https://datatracker.ietf.org/doc/html/rfc791).
    static final int
    IPV6_VALUE
    Internet Protocol v6 value as defined by [RFC 2460](https://datatracker.ietf.org/doc/html/rfc2460).
    static final int
    UUID4_VALUE
    Universally Unique Identifier, version 4, value as defined by https://datatracker.ietf.org/doc/html/rfc4122.

  • Method Summary

    Modifier and Type
    Method
    Description
    static FieldInfo.Format
    forNumber(int value)
     
    static final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptor()
     
    final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptorForType()
     
    final int
    getNumber()
     
    final com.google.protobuf.Descriptors.EnumValueDescriptor
    getValueDescriptor()
     
    static com.google.protobuf.Internal.EnumLiteMap<FieldInfo.Format>
    internalGetValueMap()
     
    static FieldInfo.Format
    valueOf(int value)
    Deprecated.
    static FieldInfo.Format
    valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
    Returns the enum constant of this type with the specified name.
    static FieldInfo.Format
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static FieldInfo.Format[]
    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 Details

    • FORMAT_UNSPECIFIED

      public static final FieldInfo.Format FORMAT_UNSPECIFIED
       Default, unspecified value.
      FORMAT_UNSPECIFIED = 0;

    • UUID4

      public static final FieldInfo.Format UUID4
       Universally Unique Identifier, version 4, value as defined by
 https://datatracker.ietf.org/doc/html/rfc4122. The value may be
 normalized to entirely lowercase letters. For example, the value
 `F47AC10B-58CC-0372-8567-0E02B2C3D479` would be normalized to
 `f47ac10b-58cc-0372-8567-0e02b2c3d479`.
      UUID4 = 1;

    • IPV4

      public static final FieldInfo.Format IPV4
       Internet Protocol v4 value as defined by [RFC
 791](https://datatracker.ietf.org/doc/html/rfc791). The value may be
 condensed, with leading zeros in each octet stripped. For example,
 `001.022.233.040` would be condensed to `1.22.233.40`.
      IPV4 = 2;

    • IPV6

      public static final FieldInfo.Format IPV6
       Internet Protocol v6 value as defined by [RFC
 2460](https://datatracker.ietf.org/doc/html/rfc2460). The value may be
 normalized to entirely lowercase letters with zeros compressed, following
 [RFC 5952](https://datatracker.ietf.org/doc/html/rfc5952). For example,
 the value `2001:0DB8:0::0` would be normalized to `2001:db8::`.
      IPV6 = 3;

    • IPV4_OR_IPV6

      public static final FieldInfo.Format IPV4_OR_IPV6
       An IP address in either v4 or v6 format as described by the individual
 values defined herein. See the comments on the IPV4 and IPV6 types for
 allowed normalizations of each.
      IPV4_OR_IPV6 = 4;

    • UNRECOGNIZED

      public static final FieldInfo.Format UNRECOGNIZED

  • Field Details

    • FORMAT_UNSPECIFIED_VALUE

      public static final int FORMAT_UNSPECIFIED_VALUE
       Default, unspecified value.
      FORMAT_UNSPECIFIED = 0;
      See Also:

    • UUID4_VALUE

      public static final int UUID4_VALUE
       Universally Unique Identifier, version 4, value as defined by
 https://datatracker.ietf.org/doc/html/rfc4122. The value may be
 normalized to entirely lowercase letters. For example, the value
 `F47AC10B-58CC-0372-8567-0E02B2C3D479` would be normalized to
 `f47ac10b-58cc-0372-8567-0e02b2c3d479`.
      UUID4 = 1;
      See Also:

    • IPV4_VALUE

      public static final int IPV4_VALUE
       Internet Protocol v4 value as defined by [RFC
 791](https://datatracker.ietf.org/doc/html/rfc791). The value may be
 condensed, with leading zeros in each octet stripped. For example,
 `001.022.233.040` would be condensed to `1.22.233.40`.
      IPV4 = 2;
      See Also:

    • IPV6_VALUE

      public static final int IPV6_VALUE
       Internet Protocol v6 value as defined by [RFC
 2460](https://datatracker.ietf.org/doc/html/rfc2460). The value may be
 normalized to entirely lowercase letters with zeros compressed, following
 [RFC 5952](https://datatracker.ietf.org/doc/html/rfc5952). For example,
 the value `2001:0DB8:0::0` would be normalized to `2001:db8::`.
      IPV6 = 3;
      See Also:

    • IPV4_OR_IPV6_VALUE

      public static final int IPV4_OR_IPV6_VALUE
       An IP address in either v4 or v6 format as described by the individual
 values defined herein. See the comments on the IPV4 and IPV6 types for
 allowed normalizations of each.
      IPV4_OR_IPV6 = 4;
      See Also:

  • Method Details

    • values

      public static FieldInfo.Format[] 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 FieldInfo.Format 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 FieldInfo.Format 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 FieldInfo.Format 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<FieldInfo.Format> 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 FieldInfo.Format 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