Reference documentation and code samples for the Google API Common Protos Client class Format.
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 type google.api.FieldInfo.Format
Namespace
Google \ Api \ FieldInfo
Methods
static::name
Parameter
Name
Description
value
mixed
static::value
Parameter
Name
Description
name
mixed
Constants
FORMAT_UNSPECIFIED
Value: 0
Default, unspecified value.
Generated from protobuf enum FORMAT_UNSPECIFIED = 0;
UUID4
Value: 1
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.
Generated from protobuf enum UUID4 = 1;
IPV4
Value: 2
Internet Protocol v4 value as defined by RFC
791. 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.
Generated from protobuf enum IPV4 = 2;
IPV6
Value: 3
Internet Protocol v6 value as defined by RFC
2460. The value may be
normalized to entirely lowercase letters with zeros compressed, following
RFC 5952. For example,
the value 2001:0DB8:0::0 would be normalized to 2001:db8::.
Generated from protobuf enum IPV6 = 3;
IPV4_OR_IPV6
Value: 4
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google API Common Protos Client - Class Format (4.12.3)\n\nVersion latestkeyboard_arrow_down\n\n- [4.12.3 (latest)](/php/docs/reference/common-protos/latest/Api.FieldInfo.Format)\n- [4.12.2](/php/docs/reference/common-protos/4.12.2/Api.FieldInfo.Format)\n- [4.11.0](/php/docs/reference/common-protos/4.11.0/Api.FieldInfo.Format)\n- [4.10.0](/php/docs/reference/common-protos/4.10.0/Api.FieldInfo.Format)\n- [4.9.0](/php/docs/reference/common-protos/4.9.0/Api.FieldInfo.Format)\n- [4.8.3](/php/docs/reference/common-protos/4.8.3/Api.FieldInfo.Format) \nReference documentation and code samples for the Google API Common Protos Client class Format.\n\nThe standard format of a field value. The supported formats are all backed\nby either an RFC defined by the IETF or a Google-defined AIP.\n\nProtobuf type `google.api.FieldInfo.Format`\n\nNamespace\n---------\n\nGoogle \\\\ Api \\\\ FieldInfo\n\nMethods\n-------\n\n### static::name\n\n### static::value\n\nConstants\n---------\n\n### FORMAT_UNSPECIFIED\n\n Value: 0\n\nDefault, unspecified value.\n\nGenerated from protobuf enum `FORMAT_UNSPECIFIED = 0;`\n\n### UUID4\n\n Value: 1\n\nUniversally Unique Identifier, version 4, value as defined by\n\u003chttps://datatracker.ietf.org/doc/html/rfc4122\u003e. The value may be\nnormalized to entirely lowercase letters. For example, the value\n`F47AC10B-58CC-0372-8567-0E02B2C3D479` would be normalized to\n`f47ac10b-58cc-0372-8567-0e02b2c3d479`.\n\nGenerated from protobuf enum `UUID4 = 1;`\n\n### IPV4\n\n Value: 2\n\nInternet Protocol v4 value as defined by [RFC\n791](https://datatracker.ietf.org/doc/html/rfc791). The value may be\ncondensed, with leading zeros in each octet stripped. For example,\n`001.022.233.040` would be condensed to `1.22.233.40`.\n\nGenerated from protobuf enum `IPV4 = 2;`\n\n### IPV6\n\n Value: 3\n\nInternet Protocol v6 value as defined by [RFC\n2460](https://datatracker.ietf.org/doc/html/rfc2460). The value may be\nnormalized to entirely lowercase letters with zeros compressed, following\n[RFC 5952](https://datatracker.ietf.org/doc/html/rfc5952). For example,\nthe value `2001:0DB8:0::0` would be normalized to `2001:db8::`.\n\nGenerated from protobuf enum `IPV6 = 3;`\n\n### IPV4_OR_IPV6\n\n Value: 4\n\nAn IP address in either v4 or v6 format as described by the individual\nvalues defined herein. See the comments on the IPV4 and IPV6 types for\nallowed normalizations of each.\n\nGenerated from protobuf enum `IPV4_OR_IPV6 = 4;`"]]
