Method: projects.locations.collections.dataStores.branches.documents.get
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/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.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Document.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name resource:
discoveryengine.documents.get
For more information, see the IAM documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This webpage details how to retrieve a specific Document resource using a GET request."],["The HTTP request uses a specific URL structure with placeholders in the path to identify the desired document, and the full resource name of the document, including project, location, collection, data store, branch, and document, is required."],["The request body for retrieving a document must be empty, and if the request is successful, the response body will contain the requested Document instance."],["Accessing this resource requires the `discoveryengine.documents.get` IAM permission, and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
