Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class EntryGroup.
Entry group metadata.
An EntryGroup resource represents a logical grouping of zero or more
Data Catalog Entry resources.
Generated from protobuf message google.cloud.datacatalog.v1.EntryGroup
Namespace
Google \ Cloud \ DataCatalog \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. |
↳ display_name |
string
A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. |
↳ description |
string
Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. |
↳ data_catalog_timestamps |
SystemTimestamps
Output only. Timestamps of the entry group. Default value is empty. |
↳ transferred_to_dataplex |
bool
Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. |
getName
Identifier. The resource name of the entry group in URL format.
Note: The entry group itself and its child resources might not be stored in the location specified in its name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the entry group in URL format.
Note: The entry group itself and its child resources might not be stored in the location specified in its name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents.
Default value is an empty string.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents.
Default value is an empty string.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataCatalogTimestamps
Output only. Timestamps of the entry group. Default value is empty.
| Returns | |
|---|---|
| Type | Description |
SystemTimestamps|null |
|
hasDataCatalogTimestamps
clearDataCatalogTimestamps
setDataCatalogTimestamps
Output only. Timestamps of the entry group. Default value is empty.
| Parameter | |
|---|---|
| Name | Description |
var |
SystemTimestamps
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTransferredToDataplex
Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setTransferredToDataplex
Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|