Google Cloud Dataplex V1 Client - Class Content (0.5.1)

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

Content represents a user-visible notebook or a sql script

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}

↳ uid string

Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.

↳ path string

Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.

↳ create_time Google\Protobuf\Timestamp

Output only. Content creation time.

↳ update_time Google\Protobuf\Timestamp

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

↳ labels array|Google\Protobuf\Internal\MapField

Optional. User defined labels for the content.

↳ description string

Optional. Description of the content.

↳ data_text string

Required. Content data in string format.

↳ sql_script Google\Cloud\Dataplex\V1\Content\SqlScript

Sql Script related configurations.

↳ notebook Google\Cloud\Dataplex\V1\Content\Notebook

Notebook related configurations.

getName

Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}

Returns
TypeDescription
string

setName

Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUid

Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.

Returns
TypeDescription
string

setUid

Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPath

Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.

Returns
TypeDescription
string

setPath

Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Content creation time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Content creation time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLabels

Optional. User defined labels for the content.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. User defined labels for the content.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getDescription

Optional. Description of the content.

Returns
TypeDescription
string

setDescription

Optional. Description of the content.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDataText

Required. Content data in string format.

Returns
TypeDescription
string

hasDataText

setDataText

Required. Content data in string format.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSqlScript

Sql Script related configurations.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Content\SqlScript|null

hasSqlScript

setSqlScript

Sql Script related configurations.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Content\SqlScript
Returns
TypeDescription
$this

getNotebook

Notebook related configurations.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Content\Notebook|null

hasNotebook

setNotebook

Notebook related configurations.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Content\Notebook
Returns
TypeDescription
$this

getData

Returns
TypeDescription
string

getContent

Returns
TypeDescription
string