Class: Google::Cloud::Dataplex::V1::EntryLink

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

Overview

EntryLink represents a link between two Entries.

Defined Under Namespace

Classes: EntryReference

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the Entry Link was created.

Returns:



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1761

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

  # Reference to the Entry that is linked through the Entry Link.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Immutable. The relative resource name of the referenced Entry,
  #     of the form:
  #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`
  # @!attribute [rw] path
  #   @return [::String]
  #     Immutable. The path in the Entry that is referenced in the Entry Link.
  #     Empty path denotes that the Entry itself is referenced in the Entry
  #     Link.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::EntryLink::EntryReference::Type]
  #     Required. Immutable. The reference type of the Entry.
  class EntryReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Reference type of the Entry.
    module Type
      # Unspecified reference type. Implies that the Entry is referenced
      # in a non-directional Entry Link.
      UNSPECIFIED = 0

      # The Entry is referenced as the source of the directional Entry Link.
      SOURCE = 2

      # The Entry is referenced as the target of the directional Entry Link.
      TARGET = 3
    end
  end
end

#entry_link_type ⇒ ::String

Returns Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example:

  • Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym
  • Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related
  • Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition.

Returns:

  • (::String) —

    Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example:

    • Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym
    • Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related
    • Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1761

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

  # Reference to the Entry that is linked through the Entry Link.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Immutable. The relative resource name of the referenced Entry,
  #     of the form:
  #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`
  # @!attribute [rw] path
  #   @return [::String]
  #     Immutable. The path in the Entry that is referenced in the Entry Link.
  #     Empty path denotes that the Entry itself is referenced in the Entry
  #     Link.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::EntryLink::EntryReference::Type]
  #     Required. Immutable. The reference type of the Entry.
  class EntryReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Reference type of the Entry.
    module Type
      # Unspecified reference type. Implies that the Entry is referenced
      # in a non-directional Entry Link.
      UNSPECIFIED = 0

      # The Entry is referenced as the source of the directional Entry Link.
      SOURCE = 2

      # The Entry is referenced as the target of the directional Entry Link.
      TARGET = 3
    end
  end
end

#entry_references ⇒ ::Array<::Google::Cloud::Dataplex::V1::EntryLink::EntryReference>

Returns Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.

Returns:



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1761

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

  # Reference to the Entry that is linked through the Entry Link.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Immutable. The relative resource name of the referenced Entry,
  #     of the form:
  #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`
  # @!attribute [rw] path
  #   @return [::String]
  #     Immutable. The path in the Entry that is referenced in the Entry Link.
  #     Empty path denotes that the Entry itself is referenced in the Entry
  #     Link.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::EntryLink::EntryReference::Type]
  #     Required. Immutable. The reference type of the Entry.
  class EntryReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Reference type of the Entry.
    module Type
      # Unspecified reference type. Implies that the Entry is referenced
      # in a non-directional Entry Link.
      UNSPECIFIED = 0

      # The Entry is referenced as the source of the directional Entry Link.
      SOURCE = 2

      # The Entry is referenced as the target of the directional Entry Link.
      TARGET = 3
    end
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.

Returns:

  • (::String) —

    Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1761

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

  # Reference to the Entry that is linked through the Entry Link.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Immutable. The relative resource name of the referenced Entry,
  #     of the form:
  #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`
  # @!attribute [rw] path
  #   @return [::String]
  #     Immutable. The path in the Entry that is referenced in the Entry Link.
  #     Empty path denotes that the Entry itself is referenced in the Entry
  #     Link.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::EntryLink::EntryReference::Type]
  #     Required. Immutable. The reference type of the Entry.
  class EntryReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Reference type of the Entry.
    module Type
      # Unspecified reference type. Implies that the Entry is referenced
      # in a non-directional Entry Link.
      UNSPECIFIED = 0

      # The Entry is referenced as the source of the directional Entry Link.
      SOURCE = 2

      # The Entry is referenced as the target of the directional Entry Link.
      TARGET = 3
    end
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the Entry Link was last updated.

Returns:



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1761

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

  # Reference to the Entry that is linked through the Entry Link.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Immutable. The relative resource name of the referenced Entry,
  #     of the form:
  #     `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`
  # @!attribute [rw] path
  #   @return [::String]
  #     Immutable. The path in the Entry that is referenced in the Entry Link.
  #     Empty path denotes that the Entry itself is referenced in the Entry
  #     Link.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dataplex::V1::EntryLink::EntryReference::Type]
  #     Required. Immutable. The reference type of the Entry.
  class EntryReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Reference type of the Entry.
    module Type
      # Unspecified reference type. Implies that the Entry is referenced
      # in a non-directional Entry Link.
      UNSPECIFIED = 0

      # The Entry is referenced as the source of the directional Entry Link.
      SOURCE = 2

      # The Entry is referenced as the target of the directional Entry Link.
      TARGET = 3
    end
  end
end