Class: Google::Cloud::DataCatalog::V1::TagField

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datacatalog/v1/tags.rb

Overview

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

Defined Under Namespace

Classes: EnumValue

Instance Attribute Summary collapse

Instance Attribute Details

#bool_value ⇒ ::Boolean

Returns The value of a tag field with a boolean type.

Returns:

  • (::Boolean) —

    The value of a tag field with a boolean type.



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 115

class TagField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An enum value.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     The display name of the enum value.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String (readonly)

Returns Output only. The display name of this field.

Returns:

  • (::String) —

    Output only. The display name of this field.



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 115

class TagField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An enum value.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     The display name of the enum value.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#double_value ⇒ ::Float

Returns The value of a tag field with a double type.

Returns:

  • (::Float) —

    The value of a tag field with a double type.



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 115

class TagField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An enum value.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     The display name of the enum value.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#enum_value ⇒ ::Google::Cloud::DataCatalog::V1::TagField::EnumValue

Returns The value of a tag field with an enum type.

This value must be one of the allowed values listed in this enum.

Returns:



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 115

class TagField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An enum value.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     The display name of the enum value.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order ⇒ ::Integer (readonly)

Returns 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.

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.



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 115

class TagField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An enum value.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     The display name of the enum value.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#richtext_value ⇒ ::String

Returns 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.

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.



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 115

class TagField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An enum value.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     The display name of the enum value.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#string_value ⇒ ::String

Returns The value of a tag field with a string type.

The maximum length is 2000 UTF-8 characters.

Returns:

  • (::String) —

    The value of a tag field with a string type.

    The maximum length is 2000 UTF-8 characters.



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 115

class TagField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An enum value.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     The display name of the enum value.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#timestamp_value ⇒ ::Google::Protobuf::Timestamp

Returns The value of a tag field with a timestamp type.

Returns:



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 115

class TagField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # An enum value.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     The display name of the enum value.
  class EnumValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end