Package com.google.cloud.discoveryengine.v1

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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getAllowMissing()
      If set to true, and the [Document][google.cloud.discoveryengine.v1.Document] is not found, a new [Document][google.cloud.discoveryengine.v1.Document] will be created.
      Document getDocument()
      Required.
      DocumentOrBuilder getDocumentOrBuilder()
      Required.
      boolean hasDocument()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • 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.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.
        .google.cloud.discoveryengine.v1.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.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.
        .google.cloud.discoveryengine.v1.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.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.
        .google.cloud.discoveryengine.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

      • getAllowMissing

        boolean getAllowMissing()
         If set to true, and the
 [Document][google.cloud.discoveryengine.v1.Document] is not found, a new
 [Document][google.cloud.discoveryengine.v1.Document] will be created.
        bool allow_missing = 2;
        Returns:
        The allowMissing.