Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::TagField (v2.5.1)

Reference documentation and code samples for the Data Catalog V1 API class Google::Cloud::DataCatalog::V1::TagField.

Contains the value and additional information on a field within a Tag.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#bool_value

def bool_value() -> ::Boolean
Returns
  • (::Boolean) — The value of a tag field with a boolean type.

    Note: The following fields are mutually exclusive: bool_value, double_value, string_value, timestamp_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bool_value=

def bool_value=(value) -> ::Boolean
Parameter
  • value (::Boolean) — The value of a tag field with a boolean type.

    Note: The following fields are mutually exclusive: bool_value, double_value, string_value, timestamp_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Boolean) — The value of a tag field with a boolean type.

    Note: The following fields are mutually exclusive: bool_value, double_value, string_value, timestamp_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Output only. The display name of this field.

#double_value

def double_value() -> ::Float
Returns
  • (::Float) — The value of a tag field with a double type.

    Note: The following fields are mutually exclusive: double_value, string_value, bool_value, timestamp_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#double_value=

def double_value=(value) -> ::Float
Parameter
  • value (::Float) — The value of a tag field with a double type.

    Note: The following fields are mutually exclusive: double_value, string_value, bool_value, timestamp_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Float) — The value of a tag field with a double type.

    Note: The following fields are mutually exclusive: double_value, string_value, bool_value, timestamp_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#enum_value

def enum_value() -> ::Google::Cloud::DataCatalog::V1::TagField::EnumValue
Returns
  • (::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.

    Note: The following fields are mutually exclusive: enum_value, double_value, string_value, bool_value, timestamp_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#enum_value=

def enum_value=(value) -> ::Google::Cloud::DataCatalog::V1::TagField::EnumValue
Parameter
  • 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.

    Note: The following fields are mutually exclusive: enum_value, double_value, string_value, bool_value, timestamp_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::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.

    Note: The following fields are mutually exclusive: enum_value, double_value, string_value, bool_value, timestamp_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#order

def order() -> ::Integer
Returns
  • (::Integer) — 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.

#richtext_value

def richtext_value() -> ::String
Returns
  • (::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.

    Note: The following fields are mutually exclusive: richtext_value, double_value, string_value, bool_value, timestamp_value, enum_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#richtext_value=

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

    Note: The following fields are mutually exclusive: richtext_value, double_value, string_value, bool_value, timestamp_value, enum_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::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.

    Note: The following fields are mutually exclusive: richtext_value, double_value, string_value, bool_value, timestamp_value, enum_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#string_value

def string_value() -> ::String
Returns
  • (::String) — The value of a tag field with a string type.

    The maximum length is 2000 UTF-8 characters.

    Note: The following fields are mutually exclusive: string_value, double_value, bool_value, timestamp_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#string_value=

def string_value=(value) -> ::String
Parameter
  • value (::String) — The value of a tag field with a string type.

    The maximum length is 2000 UTF-8 characters.

    Note: The following fields are mutually exclusive: string_value, double_value, bool_value, timestamp_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — The value of a tag field with a string type.

    The maximum length is 2000 UTF-8 characters.

    Note: The following fields are mutually exclusive: string_value, double_value, bool_value, timestamp_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#timestamp_value

def timestamp_value() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — The value of a tag field with a timestamp type.

    Note: The following fields are mutually exclusive: timestamp_value, double_value, string_value, bool_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#timestamp_value=

def timestamp_value=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — The value of a tag field with a timestamp type.

    Note: The following fields are mutually exclusive: timestamp_value, double_value, string_value, bool_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Timestamp) — The value of a tag field with a timestamp type.

    Note: The following fields are mutually exclusive: timestamp_value, double_value, string_value, bool_value, enum_value, richtext_value. If a field in that set is populated, all other fields in the set will automatically be cleared.