Dataplex V1 API - Class Google::Cloud::Dataplex::V1::AspectType::MetadataTemplate::Annotations (v1.2.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. You can include a deprecation message.

#deprecated=

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

#description

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

#description=

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

#display_name

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

#display_name=

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

#display_order

def display_order() -> ::Integer
Returns
  • (::Integer) — Optional. Display order for a field. You can use this to reorder where a field is rendered.

#display_order=

def display_order=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Display order for a field. You can use this to reorder where a field is rendered.
Returns
  • (::Integer) — Optional. Display order for a field. You can use this to reorder where a field is rendered.

#string_type

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

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

def string_values() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Suggested hints for string fields. You can use them to suggest values to users through console.

#string_values=

def string_values=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. Suggested hints for string fields. You can use them to suggest values to users through console.
Returns
  • (::Array<::String>) — Optional. Suggested hints for string fields. You can use them to suggest values to users through console.