Google Cloud Dataplex V1 Client - Class EntrySource (1.1.0)

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

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

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ resource string

The name of the resource in the source system. Maximum length is 4,000 characters.

↳ system string

The name of the source system. Maximum length is 64 characters.

↳ platform string

The platform containing the source system. Maximum length is 64 characters.

↳ display_name string

A user-friendly display name. Maximum length is 500 characters.

↳ description string

A description of the data resource. Maximum length is 2,000 characters.

↳ labels array|Google\Protobuf\Internal\MapField

User-defined labels. The maximum size of keys and values is 128 characters each.

↳ ancestors array<EntrySource\Ancestor>

Immutable. The entries representing the ancestors of the data resource in the source system.

↳ create_time Google\Protobuf\Timestamp

The time when the resource was created in the source system.

↳ update_time Google\Protobuf\Timestamp

The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.

↳ location string

Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.

getResource

The name of the resource in the source system.

Maximum length is 4,000 characters.

Returns
Type Description
string

setResource

The name of the resource in the source system.

Maximum length is 4,000 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getSystem

The name of the source system.

Maximum length is 64 characters.

Returns
Type Description
string

setSystem

The name of the source system.

Maximum length is 64 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getPlatform

The platform containing the source system.

Maximum length is 64 characters.

Returns
Type Description
string

setPlatform

The platform containing the source system.

Maximum length is 64 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

A user-friendly display name.

Maximum length is 500 characters.

Returns
Type Description
string

setDisplayName

A user-friendly display name.

Maximum length is 500 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

A description of the data resource.

Maximum length is 2,000 characters.

Returns
Type Description
string

setDescription

A description of the data resource.

Maximum length is 2,000 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

User-defined labels.

The maximum size of keys and values is 128 characters each.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

User-defined labels.

The maximum size of keys and values is 128 characters each.

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

getAncestors

Immutable. The entries representing the ancestors of the data resource in the source system.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAncestors

Immutable. The entries representing the ancestors of the data resource in the source system.

Parameter
Name Description
var array<EntrySource\Ancestor>
Returns
Type Description
$this

getCreateTime

The time when the resource was created in the source system.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time when the resource was created in the source system.

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

getUpdateTime

The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.

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

getLocation

Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.

Returns
Type Description
string

setLocation

Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.

Parameter
Name Description
var string
Returns
Type Description
$this