Google Cloud Discovery Engine V1beta Client - Class DeleteDocumentRequest (0.1.1)

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class DeleteDocumentRequest.

Request message for DocumentService.DeleteDocument method.

Generated from protobuf message google.cloud.discoveryengine.v1beta.DeleteDocumentRequest

Methods

build

Parameter
NameDescription
name string

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Document to delete does not exist, a NOT_FOUND error is returned. Please see {@see \Google\Cloud\DiscoveryEngine\V1beta\DocumentServiceClient::documentName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1beta\DeleteDocumentRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.

getName

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.

Returns
TypeDescription
string

setName

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.

Parameter
NameDescription
var string
Returns
TypeDescription
$this