Package com.google.cloud.contentwarehouse.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.
    Protobuf type google.cloud.contentwarehouse.v1.UpdateDocumentRequest
    See Also:
    Serialized Form

    • Field Detail

      • REQUEST_METADATA_FIELD_NUMBER

        public static final int REQUEST_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLOUD_AI_DOCUMENT_OPTION_FIELD_NUMBER

        public static final int CLOUD_AI_DOCUMENT_OPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_OPTIONS_FIELD_NUMBER

        public static final int UPDATE_OPTIONS_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

      • getName

        public String getName()
         Required. The name of the document to update.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}
 or
 projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface UpdateDocumentRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The name of the document to update.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}
 or
 projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface UpdateDocumentRequestOrBuilder
        Returns:
        The bytes for name.

      • hasDocument

        public boolean hasDocument()
         Required. The document to update.
        .google.cloud.contentwarehouse.v1.Document document = 2 [(.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.
        .google.cloud.contentwarehouse.v1.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDocument in interface UpdateDocumentRequestOrBuilder
        Returns:
        The document.

      • hasRequestMetadata

        public boolean hasRequestMetadata()
         The meta information collected about the end user, used to enforce access
 control for the service.
        .google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
        Specified by:
        hasRequestMetadata in interface UpdateDocumentRequestOrBuilder
        Returns:
        Whether the requestMetadata field is set.

      • getRequestMetadata

        public RequestMetadata getRequestMetadata()
         The meta information collected about the end user, used to enforce access
 control for the service.
        .google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
        Specified by:
        getRequestMetadata in interface UpdateDocumentRequestOrBuilder
        Returns:
        The requestMetadata.

      • hasCloudAiDocumentOption

        public boolean hasCloudAiDocumentOption()
         Request Option for processing Cloud AI Document in Document Warehouse.
 This field offers limited support for mapping entities from Cloud AI
 Document to Warehouse Document. Please consult with product team before
 using this field and other available options.
        .google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;
        Specified by:
        hasCloudAiDocumentOption in interface UpdateDocumentRequestOrBuilder
        Returns:
        Whether the cloudAiDocumentOption field is set.

      • getCloudAiDocumentOption

        public CloudAIDocumentOption getCloudAiDocumentOption()
         Request Option for processing Cloud AI Document in Document Warehouse.
 This field offers limited support for mapping entities from Cloud AI
 Document to Warehouse Document. Please consult with product team before
 using this field and other available options.
        .google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;
        Specified by:
        getCloudAiDocumentOption in interface UpdateDocumentRequestOrBuilder
        Returns:
        The cloudAiDocumentOption.

      • getCloudAiDocumentOptionOrBuilder

        public CloudAIDocumentOptionOrBuilder getCloudAiDocumentOptionOrBuilder()
         Request Option for processing Cloud AI Document in Document Warehouse.
 This field offers limited support for mapping entities from Cloud AI
 Document to Warehouse Document. Please consult with product team before
 using this field and other available options.
        .google.cloud.contentwarehouse.v1.CloudAIDocumentOption cloud_ai_document_option = 5;
        Specified by:
        getCloudAiDocumentOptionOrBuilder in interface UpdateDocumentRequestOrBuilder

      • hasUpdateOptions

        public boolean hasUpdateOptions()
         Options for the update operation.
        .google.cloud.contentwarehouse.v1.UpdateOptions update_options = 6;
        Specified by:
        hasUpdateOptions in interface UpdateDocumentRequestOrBuilder
        Returns:
        Whether the updateOptions field is set.

      • 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