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 are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within 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 users to attach tags to an individual column based on that schema.

For attaching a tag to a nested column, use . to separate the column names. Example:

  • outer_column.inner_column.

Returns:

  • (::String) —

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

    For attaching a tag to a nested column, use . to separate the column names. Example:

    • outer_column.inner_column


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

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. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.

Returns:

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

    Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.



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

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. Example:

  • projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}

where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.

Returns:

  • (::String) —

    The resource name of the tag in URL format. Example:

    • projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}

    where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.



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

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 that 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 that this tag uses. Example:

    • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

    This field cannot be modified after creation.



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

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.



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

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