Class: Google::Cloud::DataCatalog::V1::Tag

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

Overview

Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template.

See Data Catalog IAM for information on the permissions needed to create or view tags.

Defined Under Namespace

Classes: FieldsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#column ⇒ ::String

Returns Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema.

To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

Returns:

  • (::String) —

    Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema.

    To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 61

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DataCatalog::V1::TagField]
  class FieldsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#fields ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagField}

Returns Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

Returns:

  • (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagField}) —

    Required. Maps the ID of a tag field to its value and additional information about that field.

    Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 61

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DataCatalog::V1::TagField]
  class FieldsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns The resource name of the tag in URL format where tag ID is a system-generated identifier.

Note: The tag itself might not be stored in the location specified in its name.

Returns:

  • (::String) —

    The resource name of the tag in URL format where tag ID is a system-generated identifier.

    Note: The tag itself might not be stored in the location specified in its name.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 61

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DataCatalog::V1::TagField]
  class FieldsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#template ⇒ ::String

Returns Required. The resource name of the tag template this tag uses. Example:

projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}

This field cannot be modified after creation.

Returns:

  • (::String) —

    Required. The resource name of the tag template this tag uses. Example:

    projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}

    This field cannot be modified after creation.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 61

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DataCatalog::V1::TagField]
  class FieldsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#template_display_name ⇒ ::String (readonly)

Returns Output only. The display name of the tag template.

Returns:

  • (::String) —

    Output only. The display name of the tag template.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'proto_docs/google/cloud/datacatalog/v1/tags.rb', line 61

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DataCatalog::V1::TagField]
  class FieldsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end