Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class TagField.
Contains the value and additional information on a field within a Tag.
Generated from protobuf message google.cloud.datacatalog.v1.TagField
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ display_name |
string
Output only. The display name of this field. |
↳ double_value |
float
The value of a tag field with a double type. |
↳ string_value |
string
The value of a tag field with a string type. The maximum length is 2000 UTF-8 characters. |
↳ bool_value |
bool
The value of a tag field with a boolean type. |
↳ timestamp_value |
Google\Protobuf\Timestamp
The value of a tag field with a timestamp type. |
↳ enum_value |
Google\Cloud\DataCatalog\V1\TagField\EnumValue
The value of a tag field with an enum type. This value must be one of the allowed values listed in this enum. |
↳ richtext_value |
string
The value of a tag field with a rich text type. The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB. |
↳ order |
int
Output only. The order of this field with respect to other fields in this tag. Can be set by Tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential. |
getDisplayName
Output only. The display name of this field.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Output only. The display name of this field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDoubleValue
The value of a tag field with a double type.
| Returns | |
|---|---|
| Type | Description |
float | |
hasDoubleValue
setDoubleValue
The value of a tag field with a double type.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStringValue
The value of a tag field with a string type.
The maximum length is 2000 UTF-8 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
hasStringValue
setStringValue
The value of a tag field with a string type.
The maximum length is 2000 UTF-8 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBoolValue
The value of a tag field with a boolean type.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasBoolValue
setBoolValue
The value of a tag field with a boolean type.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTimestampValue
The value of a tag field with a timestamp type.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasTimestampValue
setTimestampValue
The value of a tag field with a timestamp type.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnumValue
The value of a tag field with an enum type.
This value must be one of the allowed values listed in this enum.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DataCatalog\V1\TagField\EnumValue|null | |
hasEnumValue
setEnumValue
The value of a tag field with an enum type.
This value must be one of the allowed values listed in this enum.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DataCatalog\V1\TagField\EnumValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRichtextValue
The value of a tag field with a rich text type.
The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
| Returns | |
|---|---|
| Type | Description |
string | |
hasRichtextValue
setRichtextValue
The value of a tag field with a rich text type.
The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrder
Output only. The order of this field with respect to other fields in this tag. Can be set by Tag.
For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.
| Returns | |
|---|---|
| Type | Description |
int | |
setOrder
Output only. The order of this field with respect to other fields in this tag. Can be set by Tag.
For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
| Returns | |
|---|---|
| Type | Description |
string | |