Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Collection.
Collection is a container for configuring resources and access to a set of DataStores.
Generated from protobuf message google.cloud.discoveryengine.v1.Collection
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. The full resource name of the Collection. Format: |
↳ display_name |
string
Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp the Collection was created at. |
getName
Immutable. The full resource name of the Collection.
Format:
projects/{project}/locations/{location}/collections/{collection_id}.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Immutable. The full resource name of the Collection.
Format:
projects/{project}/locations/{location}/collections/{collection_id}.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The Collection display name.
This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. The Collection display name.
This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Timestamp the Collection was created at.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp the Collection was created at.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|