com.google.cloud.discoveryengine.v1beta

Interface UpdateDocumentRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

UpdateDocumentRequest, UpdateDocumentRequest.Builder

public interface UpdateDocumentRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAllowMissing() If set to `true` and the [Document][google.cloud.discoveryengine.v1beta.Document] is not found, a new [Document][google.cloud.discoveryengine.v1beta.Document] is be created.
Document	getDocument() Required.
DocumentOrBuilder	getDocumentOrBuilder() Required.
com.google.protobuf.FieldMask	getUpdateMask() Indicates which fields in the provided imported 'document' to update.
com.google.protobuf.FieldMaskOrBuilder	getUpdateMaskOrBuilder() Indicates which fields in the provided imported 'document' to update.
boolean	hasDocument() Required.
boolean	hasUpdateMask() Indicates which fields in the provided imported 'document' to update.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasDocument

boolean hasDocument()

 Required. The document to update/create.

 If the caller does not have permission to update the
 [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
 

.google.cloud.discoveryengine.v1beta.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the document field is set.

getDocument

Document getDocument()

 Required. The document to update/create.

 If the caller does not have permission to update the
 [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
 

.google.cloud.discoveryengine.v1beta.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The document.

getDocumentOrBuilder

DocumentOrBuilder getDocumentOrBuilder()

 Required. The document to update/create.

 If the caller does not have permission to update the
 [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the [Document][google.cloud.discoveryengine.v1beta.Document] to update
 does not exist and
 [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing]
 is not set, a `NOT_FOUND` error is returned.
 

.google.cloud.discoveryengine.v1beta.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

getAllowMissing

boolean getAllowMissing()

 If set to `true` and the
 [Document][google.cloud.discoveryengine.v1beta.Document] is not found, a
 new [Document][google.cloud.discoveryengine.v1beta.Document] is be created.
 

bool allow_missing = 2;

Returns:

The allowMissing.

hasUpdateMask

boolean hasUpdateMask()

 Indicates which fields in the provided imported 'document' to update. If
 not set, by default updates all fields.
 

.google.protobuf.FieldMask update_mask = 3;

Returns:

Whether the updateMask field is set.

getUpdateMask

com.google.protobuf.FieldMask getUpdateMask()

 Indicates which fields in the provided imported 'document' to update. If
 not set, by default updates all fields.
 

.google.protobuf.FieldMask update_mask = 3;

Returns:

The updateMask.

getUpdateMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()

 Indicates which fields in the provided imported 'document' to update. If
 not set, by default updates all fields.
 

.google.protobuf.FieldMask update_mask = 3;