Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class Field.
A field in a schema.
Generated from protobuf message google.cloud.geminidataanalytics.v1beta.Field
Namespace
Google \ Cloud \ GeminiDataAnalytics \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Optional. The name of the field. |
↳ type |
string
Optional. The type of the field. |
↳ description |
string
Optional. A brief description of the field. |
↳ mode |
string
Optional. The mode of the field (e.g., NULLABLE, REPEATED). |
↳ display_name |
string
Optional. Field display_name (same as label in |
↳ subfields |
array<Field>
Optional. Recursive property for nested schema structures. |
↳ category |
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. |
getName
Optional. The name of the field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Optional. The name of the field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Optional. The type of the field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setType
Optional. The type of the field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A brief description of the field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A brief description of the field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMode
Optional. The mode of the field (e.g., NULLABLE, REPEATED).
| Returns | |
|---|---|
| Type | Description |
string |
|
setMode
Optional. The mode of the field (e.g., NULLABLE, REPEATED).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. Field display_name (same as label in
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. Field display_name (same as label in
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubfields
Optional. Recursive property for nested schema structures.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSubfields
Optional. Recursive property for nested schema structures.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Field>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCategory
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 | |
|---|---|
| Type | Description |
string |
|
setCategory
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|