Field(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A field in a schema.
Attributes |
|
---|---|
Name | Description |
name |
str
Optional. The name of the field. |
type_ |
str
Optional. The type of the field. |
description |
str
Optional. A brief description of the field. |
mode |
str
Optional. The mode of the field (e.g., NULLABLE, REPEATED). |
synonyms |
MutableSequence[str]
Optional. A list of alternative names or synonyms that can be used to refer to this field. For example: ["id", "customerid", "cust_id"]. Currently only used for BigQuery data sources. |
tags |
MutableSequence[str]
Optional. A list of tags or keywords associated with the field, used for categorization. For example: ["identifier", "customer", "pii"]. Currently only used for BigQuery data sources. |
display_name |
str
Optional. Field display_name (same as label in |
subfields |
MutableSequence[google.cloud.geminidataanalytics_v1alpha.types.Field]
Optional. Recursive property for nested schema structures. |
category |
str
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. |
value_format |
str
Optional. Looker only. Value format of the field. Ref: https://cloud.google.com/looker/docs/reference/param-field-value-format |