Data Analytics API with Gemini V1BETA API - Class Google::Cloud::GeminiDataAnalytics::V1beta::Field (v0.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Data Analytics API with Gemini V1BETA API class Google::Cloud::GeminiDataAnalytics::V1beta::Field.
A field in a schema.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#category
defcategory()->::String
Returns
(::String) — Optional. Field category, not required, currently only useful for Looker.
We are using a string to avoid depending on an external package and keep
this package self-contained.
#category=
defcategory=(value)->::String
Parameter
value (::String) — Optional. Field category, not required, currently only useful for Looker.
We are using a string to avoid depending on an external package and keep
this package self-contained.
Returns
(::String) — Optional. Field category, not required, currently only useful for Looker.
We are using a string to avoid depending on an external package and keep
this package self-contained.
#description
defdescription()->::String
Returns
(::String) — Optional. A brief description of the field.
#description=
defdescription=(value)->::String
Parameter
value (::String) — Optional. A brief description of the field.
Returns
(::String) — Optional. A brief description of the field.
#display_name
defdisplay_name()->::String
Returns
(::String) — Optional. Field display_name (same as label in
#display_name=
defdisplay_name=(value)->::String
Parameter
value (::String) — Optional. Field display_name (same as label in
Returns
(::String) — Optional. Field display_name (same as label in
#mode
defmode()->::String
Returns
(::String) — Optional. The mode of the field (e.g., NULLABLE, REPEATED).
#mode=
defmode=(value)->::String
Parameter
value (::String) — Optional. The mode of the field (e.g., NULLABLE, REPEATED).
Returns
(::String) — Optional. The mode of the field (e.g., NULLABLE, REPEATED).
#name
defname()->::String
Returns
(::String) — Optional. The name of the field.
#name=
defname=(value)->::String
Parameter
value (::String) — Optional. The name of the field.
(::Array<::String>) — Optional. A list of alternative names or synonyms that can be used to refer
to this field. For example: ["id", "customerid", "cust_id"]
#synonyms=
defsynonyms=(value)->::Array<::String>
Parameter
value (::Array<::String>) — Optional. A list of alternative names or synonyms that can be used to refer
to this field. For example: ["id", "customerid", "cust_id"]
Returns
(::Array<::String>) — Optional. A list of alternative names or synonyms that can be used to refer
to this field. For example: ["id", "customerid", "cust_id"]
#tags
deftags()->::Array<::String>
Returns
(::Array<::String>) — Optional. A list of tags or keywords associated with the field, used for
categorization. For example: ["identifier", "customer", "pii"]
#tags=
deftags=(value)->::Array<::String>
Parameter
value (::Array<::String>) — Optional. A list of tags or keywords associated with the field, used for
categorization. For example: ["identifier", "customer", "pii"]
Returns
(::Array<::String>) — Optional. A list of tags or keywords associated with the field, used for
categorization. For example: ["identifier", "customer", "pii"]
#type
deftype()->::String
Returns
(::String) — Optional. The type of the field.
#type=
deftype=(value)->::String
Parameter
value (::String) — Optional. The type of the field.
Returns
(::String) — Optional. The type of the field.
#value_format
defvalue_format()->::String
Returns
(::String) — Optional. Looker only. Value format of the field.
Ref:
https://cloud.google.com/looker/docs/reference/param-field-value-format
#value_format=
defvalue_format=(value)->::String
Parameter
value (::String) — Optional. Looker only. Value format of the field.
Ref:
https://cloud.google.com/looker/docs/reference/param-field-value-format
Returns
(::String) — Optional. Looker only. Value format of the field.
Ref:
https://cloud.google.com/looker/docs/reference/param-field-value-format
[[["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-27 UTC."],[],[],null,["Reference documentation and code samples for the Data Analytics API with Gemini V1BETA API class Google::Cloud::GeminiDataAnalytics::V1beta::Field.\n\nA field in a schema. \n\nInherits\n\n- Object \n\nExtended By\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n\n- Google::Protobuf::MessageExts\n\nMethods\n\n#category \n\n def category() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Field category, not required, currently only useful for Looker. We are using a string to avoid depending on an external package and keep this package self-contained.\n\n#category= \n\n def category=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Field category, not required, currently only useful for Looker. We are using a string to avoid depending on an external package and keep this package self-contained. \n**Returns**\n\n- (::String) --- Optional. Field category, not required, currently only useful for Looker. We are using a string to avoid depending on an external package and keep this package self-contained.\n\n#description \n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. A brief description of the field.\n\n#description= \n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. A brief description of the field. \n**Returns**\n\n- (::String) --- Optional. A brief description of the field.\n\n#display_name \n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Field display_name (same as label in\n\n#display_name= \n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Field display_name (same as label in \n**Returns**\n\n- (::String) --- Optional. Field display_name (same as label in\n\n#mode \n\n def mode() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The mode of the field (e.g., NULLABLE, REPEATED).\n\n#mode= \n\n def mode=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The mode of the field (e.g., NULLABLE, REPEATED). \n**Returns**\n\n- (::String) --- Optional. The mode of the field (e.g., NULLABLE, REPEATED).\n\n#name \n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The name of the field.\n\n#name= \n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The name of the field. \n**Returns**\n\n- (::String) --- Optional. The name of the field.\n\n#subfields \n\n def subfields() -\u003e ::Array\u003c::Google::Cloud::GeminiDataAnalytics::V1beta::Field\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::GeminiDataAnalytics::V1beta::Field](./Google-Cloud-GeminiDataAnalytics-V1beta-Field)\\\u003e) --- Optional. Recursive property for nested schema structures.\n\n#subfields= \n\n def subfields=(value) -\u003e ::Array\u003c::Google::Cloud::GeminiDataAnalytics::V1beta::Field\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::GeminiDataAnalytics::V1beta::Field](./Google-Cloud-GeminiDataAnalytics-V1beta-Field)\\\u003e) --- Optional. Recursive property for nested schema structures. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::GeminiDataAnalytics::V1beta::Field](./Google-Cloud-GeminiDataAnalytics-V1beta-Field)\\\u003e) --- Optional. Recursive property for nested schema structures.\n\n#synonyms \n\n def synonyms() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. A list of alternative names or synonyms that can be used to refer to this field. For example: \\[\"id\", \"customerid\", \"cust_id\"\\]\n\n#synonyms= \n\n def synonyms=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Optional. A list of alternative names or synonyms that can be used to refer to this field. For example: \\[\"id\", \"customerid\", \"cust_id\"\\] \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. A list of alternative names or synonyms that can be used to refer to this field. For example: \\[\"id\", \"customerid\", \"cust_id\"\\]\n\n#tags \n\n def tags() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. A list of tags or keywords associated with the field, used for categorization. For example: \\[\"identifier\", \"customer\", \"pii\"\\]\n\n#tags= \n\n def tags=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Optional. A list of tags or keywords associated with the field, used for categorization. For example: \\[\"identifier\", \"customer\", \"pii\"\\] \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. A list of tags or keywords associated with the field, used for categorization. For example: \\[\"identifier\", \"customer\", \"pii\"\\]\n\n#type \n\n def type() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The type of the field.\n\n#type= \n\n def type=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The type of the field. \n**Returns**\n\n- (::String) --- Optional. The type of the field.\n\n#value_format \n\n def value_format() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Looker only. Value format of the field. Ref: https://cloud.google.com/looker/docs/reference/param-field-value-format\n\n#value_format= \n\n def value_format=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Looker only. Value format of the field. Ref: https://cloud.google.com/looker/docs/reference/param-field-value-format \n**Returns**\n\n- (::String) --- Optional. Looker only. Value format of the field. Ref: https://cloud.google.com/looker/docs/reference/param-field-value-format"]]
