Package com.google.cloud.discoveryengine.v1

Class UpdateDocumentRequest

  • All Implemented Interfaces:
    UpdateDocumentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class UpdateDocumentRequest
extends com.google.protobuf.GeneratedMessageV3
implements UpdateDocumentRequestOrBuilder
     Request message for
 [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1.DocumentService.UpdateDocument]
 method.
    Protobuf type google.cloud.discoveryengine.v1.UpdateDocumentRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UpdateDocumentRequest.Builder
      Request message for [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1.DocumentService.UpdateDocument] method.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALLOW_MISSING_FIELD_NUMBER  
      static int DOCUMENT_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • ALLOW_MISSING_FIELD_NUMBER

        public static final int ALLOW_MISSING_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasDocument

        public 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];
        Specified by:
        hasDocument in interface UpdateDocumentRequestOrBuilder
        Returns:
        Whether the document field is set.

      • getDocument

        public 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];
        Specified by:
        getDocument in interface UpdateDocumentRequestOrBuilder
        Returns:
        The document.

      • getDocumentOrBuilder

        public 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];
        Specified by:
        getDocumentOrBuilder in interface UpdateDocumentRequestOrBuilder

      • getAllowMissing

        public 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;
        Specified by:
        getAllowMissing in interface UpdateDocumentRequestOrBuilder
        Returns:
        The allowMissing.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static UpdateDocumentRequest parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateDocumentRequest parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateDocumentRequest parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateDocumentRequest parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateDocumentRequest parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateDocumentRequest parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public UpdateDocumentRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public UpdateDocumentRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected UpdateDocumentRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<UpdateDocumentRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public UpdateDocumentRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder