Google Cloud Dataplex V1 Client - Class EntryLink (1.12.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class EntryLink.

EntryLink represents a link between two Entries.

Generated from protobuf message google.cloud.dataplex.v1.EntryLink

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name 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}
↳ entry_link_type 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
↳ create_time Google\Protobuf\Timestamp

Output only. The time when the Entry Link was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The time when the Entry Link was last updated.
↳ aspects array|Google\Protobuf\Internal\MapField

Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
↳ entry_references array<EntryLink\EntryReference>

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

getName

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
Type Description
string

setName

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}

Parameter
Name Description
var string
Returns
Type Description
$this

getEntryLinkType

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
Type Description
string

setEntryLinkType

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
Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getAspects

Optional. The aspects that are attached to the entry link.

The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.

Returns
Type Description
Google\Protobuf\Internal\MapField

setAspects

Optional. The aspects that are attached to the entry link.

The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getEntryReferences

Required. Immutable. Specifies the Entries referenced in the Entry Link.

There should be exactly two entry references.

Returns
Type Description
Google\Protobuf\RepeatedField<EntryLink\EntryReference>

setEntryReferences

Required. Immutable. Specifies the Entries referenced in the Entry Link.

There should be exactly two entry references.

Parameter
Name Description
var array<EntryLink\EntryReference>
Returns
Type Description
$this