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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
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}
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string path = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string path = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Content creation time.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Content creation time.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time when the content was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the content was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Optional. User defined labels for the content.
Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Optional. User defined labels for the content.
Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. Description of the content.
Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. Description of the content.
Generated from protobuf field string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataText
Required. Content data in string format.
Generated from protobuf field string data_text = 9 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
hasDataText
setDataText
Required. Content data in string format.
Generated from protobuf field string data_text = 9 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSqlScript
Sql Script related configurations.
Generated from protobuf field .google.cloud.dataplex.v1.Content.SqlScript sql_script = 100;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Content\SqlScript|null | |
hasSqlScript
setSqlScript
Sql Script related configurations.
Generated from protobuf field .google.cloud.dataplex.v1.Content.SqlScript sql_script = 100;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Content\SqlScript
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNotebook
Notebook related configurations.
Generated from protobuf field .google.cloud.dataplex.v1.Content.Notebook notebook = 101;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Content\Notebook|null | |
hasNotebook
setNotebook
Notebook related configurations.
Generated from protobuf field .google.cloud.dataplex.v1.Content.Notebook notebook = 101;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Content\Notebook
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getData
| Returns | |
|---|---|
| Type | Description |
string | |
getContent
| Returns | |
|---|---|
| Type | Description |
string | |