Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class CreateDocumentRequest.
Request message for DocumentService.CreateDocument method.
Generated from protobuf message google.cloud.discoveryengine.v1beta.CreateDocumentRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ parent | stringRequired. The parent resource name, such as |
↳ document | Google\Cloud\DiscoveryEngine\V1beta\DocumentRequired. The Document to create. |
↳ document_id | stringRequired. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a |
getParent
Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDocument
Required. The Document to create.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1beta\Document|null | |
hasDocument
clearDocument
setDocument
Required. The Document to create.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\DiscoveryEngine\V1beta\Document |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDocumentId
Required. The ID to use for the Document, which will become the final component of the Document.name.
If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
| Returns | |
|---|---|
| Type | Description |
string | |
setDocumentId
Required. The ID to use for the Document, which will become the final component of the Document.name.
If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The parent resource name, such as |
document | Google\Cloud\DiscoveryEngine\V1beta\DocumentRequired. The Document to create. |
documentId | stringRequired. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a This field must be unique among all Documents with the same parent. Otherwise, an This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1beta\CreateDocumentRequest | |