Discovery Engine v1beta API - Class GetDocumentRequest (1.0.0-beta17)

Version 1.0.0-beta17

• 1.0.0-beta18 (latest)
• 1.0.0-beta17

public sealed class GetDocumentRequest : IMessage<GetDocumentRequest>, IEquatable<GetDocumentRequest>, IDeepCloneable<GetDocumentRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class GetDocumentRequest.

Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] method.

Inheritance

object > GetDocumentRequest

Implements

IMessageGetDocumentRequest, IEquatableGetDocumentRequest, IDeepCloneableGetDocumentRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.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.v1beta.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.v1beta.Document], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [Document][google.cloud.discoveryengine.v1beta.Document] does not exist, a NOT_FOUND error is returned.

Property Value
Type	Description
string