public sealed class UpdateDocumentRequest : IMessage<UpdateDocumentRequest>, IEquatable<UpdateDocumentRequest>, IDeepCloneable<UpdateDocumentRequest>, IBufferMessage, IMessageReference documentation and code samples for the Discovery Engine v1 API class UpdateDocumentRequest.
Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1.DocumentService.UpdateDocument] method.
Implements
IMessageUpdateDocumentRequest, IEquatableUpdateDocumentRequest, IDeepCloneableUpdateDocumentRequest, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
UpdateDocumentRequest()
public UpdateDocumentRequest()UpdateDocumentRequest(UpdateDocumentRequest)
public UpdateDocumentRequest(UpdateDocumentRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
UpdateDocumentRequest |
Properties
AllowMissing
public bool AllowMissing { get; set; }If set to true and the
[Document][google.cloud.discoveryengine.v1.Document] is not found, a new
[Document][google.cloud.discoveryengine.v1.Document] is be created.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Document
public Document Document { get; set; }Required. The document to update/create.
If the caller does not have permission to update the
[Document][google.cloud.discoveryengine.v1.Document], regardless of whether
or not it exists, a PERMISSION_DENIED error is returned.
If the [Document][google.cloud.discoveryengine.v1.Document] to update does
not exist and
[allow_missing][google.cloud.discoveryengine.v1.UpdateDocumentRequest.allow_missing]
is not set, a NOT_FOUND error is returned.
| Property Value | |
|---|---|
| Type | Description |
Document |
|
UpdateMask
public FieldMask UpdateMask { get; set; }Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.
| Property Value | |
|---|---|
| Type | Description |
FieldMask |
|