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. You can include a deprecation message. |
↳ display_name |
string
Optional. Display name for a field. |
↳ description |
string
Optional. Description for a field. |
↳ display_order |
int
Optional. Display order for a field. You can use this to reorder where a field is rendered. |
↳ string_type |
string
Optional. You can use String Type annotations 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 |
string[]
Optional. Suggested hints for string fields. You can use them to suggest values to users through console. |
getDeprecated
Optional. Marks a field as deprecated. You can include a deprecation message.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDeprecated
Optional. Marks a field as deprecated. You can include a deprecation message.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. Display name for a field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. Display name for a field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description for a field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description for a field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayOrder
Optional. Display order for a field. You can use this to reorder where a field is rendered.
| Returns | |
|---|---|
| Type | Description |
int |
|
setDisplayOrder
Optional. Display order for a field. You can use this to reorder where a field is rendered.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStringType
Optional. You can use String Type annotations 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. You can use String Type annotations 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. You can use them to suggest values to users through console.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setStringValues
Optional. Suggested hints for string fields. You can use them to suggest values to users through console.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|