Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class GetDocumentRequest.
Request message for
DocumentService.GetDocument
method.
Generated from protobuf message google.cloud.discoveryengine.v1beta.GetDocumentRequest
Methods
__construct
Constructor.
Parameters
Name
Description
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 access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document 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 access the
Document, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
If the requested Document
does not exist, a NOT_FOUND error is returned.
Returns
Type
Description
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 access the
Document, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
If the requested Document
does not exist, a NOT_FOUND error is returned.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
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 access the
Document, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
If the requested Document
does not exist, a NOT_FOUND error is returned. Please see
{@see \Google\Cloud\DiscoveryEngine\V1beta\DocumentServiceClient::documentName()} for help formatting this field.
