Reference documentation and code samples for the Network Services V1 API class Google::Api::FieldInfo.
Rich semantic information of an API field beyond basic typing.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#format
defformat()->::Google::Api::FieldInfo::Format
Returns
(::Google::Api::FieldInfo::Format) — The standard format of a field value. This does not explicitly configure
any API consumer, just documents the API's format for the field it is
applied to.
value (::Google::Api::FieldInfo::Format) — The standard format of a field value. This does not explicitly configure
any API consumer, just documents the API's format for the field it is
applied to.
Returns
(::Google::Api::FieldInfo::Format) — The standard format of a field value. This does not explicitly configure
any API consumer, just documents the API's format for the field it is
applied to.
[[["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-08-28 UTC."],[],[],null,["# Network Services V1 API - Class Google::Api::FieldInfo (v2.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.4.0 (latest)](/ruby/docs/reference/google-cloud-network_services-v1/latest/Google-Api-FieldInfo)\n- [2.3.0](/ruby/docs/reference/google-cloud-network_services-v1/2.3.0/Google-Api-FieldInfo)\n- [2.2.0](/ruby/docs/reference/google-cloud-network_services-v1/2.2.0/Google-Api-FieldInfo)\n- [2.1.0](/ruby/docs/reference/google-cloud-network_services-v1/2.1.0/Google-Api-FieldInfo)\n- [2.0.1](/ruby/docs/reference/google-cloud-network_services-v1/2.0.1/Google-Api-FieldInfo)\n- [1.2.0](/ruby/docs/reference/google-cloud-network_services-v1/1.2.0/Google-Api-FieldInfo)\n- [1.1.0](/ruby/docs/reference/google-cloud-network_services-v1/1.1.0/Google-Api-FieldInfo)\n- [1.0.1](/ruby/docs/reference/google-cloud-network_services-v1/1.0.1/Google-Api-FieldInfo)\n- [0.2.0](/ruby/docs/reference/google-cloud-network_services-v1/0.2.0/Google-Api-FieldInfo)\n- [0.1.0](/ruby/docs/reference/google-cloud-network_services-v1/0.1.0/Google-Api-FieldInfo) \nReference documentation and code samples for the Network Services V1 API class Google::Api::FieldInfo.\n\nRich semantic information of an API field beyond basic typing. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #format\n\n def format() -\u003e ::Google::Api::FieldInfo::Format\n\n**Returns**\n\n- ([::Google::Api::FieldInfo::Format](./Google-Api-FieldInfo-Format)) --- The standard format of a field value. This does not explicitly configure any API consumer, just documents the API's format for the field it is applied to.\n\n### #format=\n\n def format=(value) -\u003e ::Google::Api::FieldInfo::Format\n\n**Parameter**\n\n- **value** ([::Google::Api::FieldInfo::Format](./Google-Api-FieldInfo-Format)) --- The standard format of a field value. This does not explicitly configure any API consumer, just documents the API's format for the field it is applied to. \n**Returns**\n\n- ([::Google::Api::FieldInfo::Format](./Google-Api-FieldInfo-Format)) --- The standard format of a field value. This does not explicitly configure any API consumer, just documents the API's format for the field it is applied to.\n\n### #referenced_types\n\n def referenced_types() -\u003e ::Array\u003c::Google::Api::TypeReference\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Api::TypeReference](./Google-Api-TypeReference)\\\u003e) --- The type(s) that the annotated, generic field may represent.\n\n\n Currently, this must only be used on fields of type `google.protobuf.Any`.\n Supporting other generic types may be considered in the future.\n\n### #referenced_types=\n\n def referenced_types=(value) -\u003e ::Array\u003c::Google::Api::TypeReference\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Api::TypeReference](./Google-Api-TypeReference)\\\u003e) --- The type(s) that the annotated, generic field may represent.\n\n\n Currently, this must only be used on fields of type `google.protobuf.Any`.\nSupporting other generic types may be considered in the future. \n**Returns**\n\n- (::Array\\\u003c[::Google::Api::TypeReference](./Google-Api-TypeReference)\\\u003e) --- The type(s) that the annotated, generic field may represent.\n\n\n Currently, this must only be used on fields of type `google.protobuf.Any`.\n Supporting other generic types may be considered in the future."]]
