Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ConnectorMetadata.
User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
Generated from protobuf message google.cloud.discoveryengine.v1.DataConnector.ConnectorMetadata
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ DataConnectorMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ title |
string
Optional. Display title of the connector. |
↳ description |
string
Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. |
↳ short_description |
string
Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). |
↳ author |
string
Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector. |
↳ note |
string
Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. |
getTitle
Optional. Display title of the connector.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTitle
Optional. Display title of the connector.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShortDescription
Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).
| Returns | |
|---|---|
| Type | Description |
string |
|
setShortDescription
Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAuthor
Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAuthor
Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNote
Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNote
Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|