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
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
.
↳ document
↳ document_id
string
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 Document
s 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.
getParent
Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
.
string
setParent
Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
.
var
string
$this
getDocument
Required. The Document to create.
hasDocument
clearDocument
setDocument
Required. The Document to create.
$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 Document
s 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.
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 Document
s 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.
var
string
$this
static::build
parent
string
Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
. Please see
{@see \Google\Cloud\DiscoveryEngine\V1beta\DocumentServiceClient::branchName()} for help formatting this field.
document
documentId
string
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 Document
s 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.
