Google Cloud Dataplex V1 Client - Class Entry (0.16.0)

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

An entry is a representation of a data asset which 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, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
↳ entry_type string

Required. Immutable. The resource name of the EntryType used to create this Entry.
↳ create_time Google\Protobuf\Timestamp

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

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

Optional. The Aspects attached to the Entry. The format for the key can be one of the following: 1. {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) 2. {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's 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 reference it in an external system. The maximum size of the field is 4000 characters.
↳ entry_source Google\Cloud\Dataplex\V1\EntrySource

Optional. Source system related information for an entry.

getName

Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.

Returns
Type Description
string

setName

Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.

Parameter
Name Description
var string
Returns
Type Description
$this

getEntryType

Required. Immutable. The resource name of the EntryType used to create this Entry.

Returns
Type Description
string

setEntryType

Required. Immutable. The resource name of the EntryType used to create this Entry.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time when the Entry was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the Entry was created.

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

getUpdateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

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

getAspects

Optional. The Aspects attached to the Entry.

The format for the key can be one of the following:

  1. {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry)
  2. {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path)
Returns
Type Description
Google\Protobuf\Internal\MapField

setAspects

Optional. The Aspects attached to the Entry.

The format for the key can be one of the following:

  1. {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry)
  2. {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path)
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
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 reference it in an external system.

The maximum size of the field is 4000 characters.

Returns
Type Description
string

setFullyQualifiedName

Optional. A name for the entry that can reference it in an external system.

The maximum size of the field is 4000 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getEntrySource

Optional. Source system related information for an entry.

Returns
Type Description
Google\Cloud\Dataplex\V1\EntrySource|null

hasEntrySource

clearEntrySource

setEntrySource

Optional. Source system related information for an entry.

Parameter
Name Description
var Google\Cloud\Dataplex\V1\EntrySource
Returns
Type Description
$this