Dataplex V1 API - Class Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations (v0.22.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations.

Definition of the annotations of a field

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#deprecated

def deprecated() -> ::String
Returns
  • (::String) — Optional. Marks a field as deprecated, a deprecation message can be included.

#deprecated=

def deprecated=(value) -> ::String
Parameter
  • value (::String) — Optional. Marks a field as deprecated, a deprecation message can be included.
Returns
  • (::String) — Optional. Marks a field as deprecated, a deprecation message can be included.

#description

def description() -> ::String
Returns
  • (::String) — Optional. Specify a description for a field

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Specify a description for a field
Returns
  • (::String) — Optional. Specify a description for a field

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. Specify a displayname for a field.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. Specify a displayname for a field.
Returns
  • (::String) — Optional. Specify a displayname for a field.

#display_order

def display_order() -> ::Integer
Returns
  • (::Integer) — Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered

#display_order=

def display_order=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered
Returns
  • (::Integer) — Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered

#string_type

def string_type() -> ::String
Returns
  • (::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_type=

def string_type=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def string_values() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

#string_values=

def string_values=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.
Returns
  • (::Array<::String>) — Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.