public sealed class GetDocumentRequest : IMessage<GetDocumentRequest>, IEquatable<GetDocumentRequest>, IDeepCloneable<GetDocumentRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1 API class GetDocumentRequest.
Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] method.
Implements
IMessageGetDocumentRequest, IEquatableGetDocumentRequest, IDeepCloneableGetDocumentRequest, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
GetDocumentRequest()
public GetDocumentRequest()
GetDocumentRequest(GetDocumentRequest)
public GetDocumentRequest(GetDocumentRequest other)
Parameter | |
---|---|
Name | Description |
other |
GetDocumentRequest |
Properties
DocumentName
public DocumentName DocumentName { get; set; }
DocumentName-typed view over the Name resource name property.
Property Value | |
---|---|
Type | Description |
DocumentName |
Name
public string Name { get; set; }
Required. Full resource name of
[Document][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.Document], regardless of whether
or not it exists, a PERMISSION_DENIED
error is returned.
If the requested [Document][google.cloud.discoveryengine.v1.Document] does
not exist, a NOT_FOUND
error is returned.
Property Value | |
---|---|
Type | Description |
string |