Google Cloud Dataplex V1 Client - Class Entry (1.2.1)

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

An entry is a representation of a data resource that can be described by various metadata.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} .

↳ entry_type
string

Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id} .

↳ create_time
Google\Protobuf\Timestamp

Output only. The time when the entry was created in Dataplex.

↳ update_time
Google\Protobuf\Timestamp

Output only. The time when the entry was last updated in Dataplex.

↳ aspects
array| Google\Protobuf\Internal\MapField

Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: * * If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} * * If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}

↳ parent_entry
string

Optional. Immutable. The resource name of the parent entry.

↳ fully_qualified_name
string

Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names . The maximum size of the field is 4000 characters.

↳ entry_source
EntrySource

Optional. Information related to the source system of the data resource that is represented by the entry.

getName

Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} .

Returns
Type
Description
string

setName

Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEntryType

Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id} .

Returns
Type
Description
string

setEntryType

Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id} .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. The time when the entry was created in Dataplex.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the entry was created in Dataplex.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The time when the entry was last updated in Dataplex.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the entry was last updated in Dataplex.

Parameter
Name
Description
Returns
Type
Description
$this

getAspects

Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following:

  • If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id}
  • If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
Returns
Type
Description

setAspects

Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following:

  • If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id}
  • If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
Parameter
Name
Description
Returns
Type
Description
$this

getParentEntry

Optional. Immutable. The resource name of the parent entry.

Returns
Type
Description
string

setParentEntry

Optional. Immutable. The resource name of the parent entry.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFullyQualifiedName

Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names .

The maximum size of the field is 4000 characters.

Returns
Type
Description
string

setFullyQualifiedName

Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names .

The maximum size of the field is 4000 characters.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEntrySource

Optional. Information related to the source system of the data resource that is represented by the entry.

Returns
Type
Description
EntrySource |null

hasEntrySource

clearEntrySource

setEntrySource

Optional. Information related to the source system of the data resource that is represented by the entry.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: