Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Annotations.
Definition of the annotations of a field
Generated from protobuf message google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations
Namespace
Google \ Cloud \ Dataplex \ V1 \ AspectType \ MetadataTemplateMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ deprecated |
string
Optional. Marks a field as deprecated, a deprecation message can be included. |
↳ display_name |
string
Optional. Specify a displayname for a field. |
↳ description |
string
Optional. Specify a description for a field |
↳ display_order |
int
Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered |
↳ string_type |
string
Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference. |
↳ string_values |
array
Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example. |
getDeprecated
Optional. Marks a field as deprecated, a deprecation message can be included.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDeprecated
Optional. Marks a field as deprecated, a deprecation message can be included.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. Specify a displayname for a field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. Specify a displayname for a field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Specify a description for a field
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Specify a description for a field
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayOrder
Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered
| Returns | |
|---|---|
| Type | Description |
int |
|
setDisplayOrder
Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStringType
Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStringType
Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStringValues
Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setStringValues
Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|