Class Document.Builder

  • All Implemented Interfaces:
    DocumentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Document

    public static final class Document.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
    implements DocumentOrBuilder
     Defines the structure for content warehouse document proto.
     
    Protobuf type google.cloud.contentwarehouse.v1.Document
    • Method Detail

      • 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.Builder<Document.Builder>
      • clear

        public Document.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
      • getDefaultInstanceForType

        public Document getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public Document build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public Document buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public Document.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
      • setField

        public Document.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
      • clearField

        public Document.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
      • clearOneof

        public Document.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
      • setRepeatedField

        public Document.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
      • addRepeatedField

        public Document.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
      • mergeFrom

        public Document.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
      • mergeFrom

        public Document.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>
        Throws:
        IOException
      • getName

        public String getName()
         The resource name of the document.
         Format:
         projects/{project_number}/locations/{location}/documents/{document_id}.
        
         The name is ignored when creating a document.
         
        string name = 1;
        Specified by:
        getName in interface DocumentOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The resource name of the document.
         Format:
         projects/{project_number}/locations/{location}/documents/{document_id}.
        
         The name is ignored when creating a document.
         
        string name = 1;
        Specified by:
        getNameBytes in interface DocumentOrBuilder
        Returns:
        The bytes for name.
      • setName

        public Document.Builder setName​(String value)
         The resource name of the document.
         Format:
         projects/{project_number}/locations/{location}/documents/{document_id}.
        
         The name is ignored when creating a document.
         
        string name = 1;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.
      • clearName

        public Document.Builder clearName()
         The resource name of the document.
         Format:
         projects/{project_number}/locations/{location}/documents/{document_id}.
        
         The name is ignored when creating a document.
         
        string name = 1;
        Returns:
        This builder for chaining.
      • setNameBytes

        public Document.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The resource name of the document.
         Format:
         projects/{project_number}/locations/{location}/documents/{document_id}.
        
         The name is ignored when creating a document.
         
        string name = 1;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.
      • getReferenceId

        public String getReferenceId()
         The reference ID set by customers. Must be unique per project and location.
         
        string reference_id = 11;
        Specified by:
        getReferenceId in interface DocumentOrBuilder
        Returns:
        The referenceId.
      • getReferenceIdBytes

        public com.google.protobuf.ByteString getReferenceIdBytes()
         The reference ID set by customers. Must be unique per project and location.
         
        string reference_id = 11;
        Specified by:
        getReferenceIdBytes in interface DocumentOrBuilder
        Returns:
        The bytes for referenceId.
      • setReferenceId

        public Document.Builder setReferenceId​(String value)
         The reference ID set by customers. Must be unique per project and location.
         
        string reference_id = 11;
        Parameters:
        value - The referenceId to set.
        Returns:
        This builder for chaining.
      • clearReferenceId

        public Document.Builder clearReferenceId()
         The reference ID set by customers. Must be unique per project and location.
         
        string reference_id = 11;
        Returns:
        This builder for chaining.
      • setReferenceIdBytes

        public Document.Builder setReferenceIdBytes​(com.google.protobuf.ByteString value)
         The reference ID set by customers. Must be unique per project and location.
         
        string reference_id = 11;
        Parameters:
        value - The bytes for referenceId to set.
        Returns:
        This builder for chaining.
      • getDisplayName

        public String getDisplayName()
         Required. Display name of the document given by the user. This name will be
         displayed in the UI. Customer can populate this field with the name of the
         document. This differs from the 'title' field as 'title' is optional and
         stores the top heading in the document.
         
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface DocumentOrBuilder
        Returns:
        The displayName.
      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. Display name of the document given by the user. This name will be
         displayed in the UI. Customer can populate this field with the name of the
         document. This differs from the 'title' field as 'title' is optional and
         stores the top heading in the document.
         
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface DocumentOrBuilder
        Returns:
        The bytes for displayName.
      • setDisplayName

        public Document.Builder setDisplayName​(String value)
         Required. Display name of the document given by the user. This name will be
         displayed in the UI. Customer can populate this field with the name of the
         document. This differs from the 'title' field as 'title' is optional and
         stores the top heading in the document.
         
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.
      • clearDisplayName

        public Document.Builder clearDisplayName()
         Required. Display name of the document given by the user. This name will be
         displayed in the UI. Customer can populate this field with the name of the
         document. This differs from the 'title' field as 'title' is optional and
         stores the top heading in the document.
         
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.
      • setDisplayNameBytes

        public Document.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         Required. Display name of the document given by the user. This name will be
         displayed in the UI. Customer can populate this field with the name of the
         document. This differs from the 'title' field as 'title' is optional and
         stores the top heading in the document.
         
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.
      • getTitle

        public String getTitle()
         Title that describes the document.
         This can be the top heading or text that describes the document.
         
        string title = 18;
        Specified by:
        getTitle in interface DocumentOrBuilder
        Returns:
        The title.
      • getTitleBytes

        public com.google.protobuf.ByteString getTitleBytes()
         Title that describes the document.
         This can be the top heading or text that describes the document.
         
        string title = 18;
        Specified by:
        getTitleBytes in interface DocumentOrBuilder
        Returns:
        The bytes for title.
      • setTitle

        public Document.Builder setTitle​(String value)
         Title that describes the document.
         This can be the top heading or text that describes the document.
         
        string title = 18;
        Parameters:
        value - The title to set.
        Returns:
        This builder for chaining.
      • clearTitle

        public Document.Builder clearTitle()
         Title that describes the document.
         This can be the top heading or text that describes the document.
         
        string title = 18;
        Returns:
        This builder for chaining.
      • setTitleBytes

        public Document.Builder setTitleBytes​(com.google.protobuf.ByteString value)
         Title that describes the document.
         This can be the top heading or text that describes the document.
         
        string title = 18;
        Parameters:
        value - The bytes for title to set.
        Returns:
        This builder for chaining.
      • getDisplayUri

        public String getDisplayUri()
         Uri to display the document, for example, in the UI.
         
        string display_uri = 17;
        Specified by:
        getDisplayUri in interface DocumentOrBuilder
        Returns:
        The displayUri.
      • getDisplayUriBytes

        public com.google.protobuf.ByteString getDisplayUriBytes()
         Uri to display the document, for example, in the UI.
         
        string display_uri = 17;
        Specified by:
        getDisplayUriBytes in interface DocumentOrBuilder
        Returns:
        The bytes for displayUri.
      • setDisplayUri

        public Document.Builder setDisplayUri​(String value)
         Uri to display the document, for example, in the UI.
         
        string display_uri = 17;
        Parameters:
        value - The displayUri to set.
        Returns:
        This builder for chaining.
      • clearDisplayUri

        public Document.Builder clearDisplayUri()
         Uri to display the document, for example, in the UI.
         
        string display_uri = 17;
        Returns:
        This builder for chaining.
      • setDisplayUriBytes

        public Document.Builder setDisplayUriBytes​(com.google.protobuf.ByteString value)
         Uri to display the document, for example, in the UI.
         
        string display_uri = 17;
        Parameters:
        value - The bytes for displayUri to set.
        Returns:
        This builder for chaining.
      • getDocumentSchemaName

        public String getDocumentSchemaName()
         The Document schema name.
         Format:
         projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
         
        string document_schema_name = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDocumentSchemaName in interface DocumentOrBuilder
        Returns:
        The documentSchemaName.
      • getDocumentSchemaNameBytes

        public com.google.protobuf.ByteString getDocumentSchemaNameBytes()
         The Document schema name.
         Format:
         projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
         
        string document_schema_name = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDocumentSchemaNameBytes in interface DocumentOrBuilder
        Returns:
        The bytes for documentSchemaName.
      • setDocumentSchemaName

        public Document.Builder setDocumentSchemaName​(String value)
         The Document schema name.
         Format:
         projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
         
        string document_schema_name = 3 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The documentSchemaName to set.
        Returns:
        This builder for chaining.
      • clearDocumentSchemaName

        public Document.Builder clearDocumentSchemaName()
         The Document schema name.
         Format:
         projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
         
        string document_schema_name = 3 [(.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.
      • setDocumentSchemaNameBytes

        public Document.Builder setDocumentSchemaNameBytes​(com.google.protobuf.ByteString value)
         The Document schema name.
         Format:
         projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
         
        string document_schema_name = 3 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for documentSchemaName to set.
        Returns:
        This builder for chaining.
      • hasPlainText

        public boolean hasPlainText()
         Other document format, such as PPTX, XLXS
         
        string plain_text = 15;
        Specified by:
        hasPlainText in interface DocumentOrBuilder
        Returns:
        Whether the plainText field is set.
      • getPlainText

        public String getPlainText()
         Other document format, such as PPTX, XLXS
         
        string plain_text = 15;
        Specified by:
        getPlainText in interface DocumentOrBuilder
        Returns:
        The plainText.
      • getPlainTextBytes

        public com.google.protobuf.ByteString getPlainTextBytes()
         Other document format, such as PPTX, XLXS
         
        string plain_text = 15;
        Specified by:
        getPlainTextBytes in interface DocumentOrBuilder
        Returns:
        The bytes for plainText.
      • setPlainText

        public Document.Builder setPlainText​(String value)
         Other document format, such as PPTX, XLXS
         
        string plain_text = 15;
        Parameters:
        value - The plainText to set.
        Returns:
        This builder for chaining.
      • clearPlainText

        public Document.Builder clearPlainText()
         Other document format, such as PPTX, XLXS
         
        string plain_text = 15;
        Returns:
        This builder for chaining.
      • setPlainTextBytes

        public Document.Builder setPlainTextBytes​(com.google.protobuf.ByteString value)
         Other document format, such as PPTX, XLXS
         
        string plain_text = 15;
        Parameters:
        value - The bytes for plainText to set.
        Returns:
        This builder for chaining.
      • hasCloudAiDocument

        public boolean hasCloudAiDocument()
         Document AI format to save the structured content, including OCR.
         
        .google.cloud.documentai.v1.Document cloud_ai_document = 4;
        Specified by:
        hasCloudAiDocument in interface DocumentOrBuilder
        Returns:
        Whether the cloudAiDocument field is set.
      • getCloudAiDocument

        public com.google.cloud.documentai.v1.Document getCloudAiDocument()
         Document AI format to save the structured content, including OCR.
         
        .google.cloud.documentai.v1.Document cloud_ai_document = 4;
        Specified by:
        getCloudAiDocument in interface DocumentOrBuilder
        Returns:
        The cloudAiDocument.
      • setCloudAiDocument

        public Document.Builder setCloudAiDocument​(com.google.cloud.documentai.v1.Document value)
         Document AI format to save the structured content, including OCR.
         
        .google.cloud.documentai.v1.Document cloud_ai_document = 4;
      • setCloudAiDocument

        public Document.Builder setCloudAiDocument​(com.google.cloud.documentai.v1.Document.Builder builderForValue)
         Document AI format to save the structured content, including OCR.
         
        .google.cloud.documentai.v1.Document cloud_ai_document = 4;
      • mergeCloudAiDocument

        public Document.Builder mergeCloudAiDocument​(com.google.cloud.documentai.v1.Document value)
         Document AI format to save the structured content, including OCR.
         
        .google.cloud.documentai.v1.Document cloud_ai_document = 4;
      • clearCloudAiDocument

        public Document.Builder clearCloudAiDocument()
         Document AI format to save the structured content, including OCR.
         
        .google.cloud.documentai.v1.Document cloud_ai_document = 4;
      • getCloudAiDocumentBuilder

        public com.google.cloud.documentai.v1.Document.Builder getCloudAiDocumentBuilder()
         Document AI format to save the structured content, including OCR.
         
        .google.cloud.documentai.v1.Document cloud_ai_document = 4;
      • getCloudAiDocumentOrBuilder

        public com.google.cloud.documentai.v1.DocumentOrBuilder getCloudAiDocumentOrBuilder()
         Document AI format to save the structured content, including OCR.
         
        .google.cloud.documentai.v1.Document cloud_ai_document = 4;
        Specified by:
        getCloudAiDocumentOrBuilder in interface DocumentOrBuilder
      • getStructuredContentUri

        @Deprecated
        public String getStructuredContentUri()
        Deprecated.
        google.cloud.contentwarehouse.v1.Document.structured_content_uri is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=79
         A path linked to structured content file.
         
        string structured_content_uri = 16 [deprecated = true];
        Specified by:
        getStructuredContentUri in interface DocumentOrBuilder
        Returns:
        The structuredContentUri.
      • getStructuredContentUriBytes

        @Deprecated
        public com.google.protobuf.ByteString getStructuredContentUriBytes()
        Deprecated.
        google.cloud.contentwarehouse.v1.Document.structured_content_uri is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=79
         A path linked to structured content file.
         
        string structured_content_uri = 16 [deprecated = true];
        Specified by:
        getStructuredContentUriBytes in interface DocumentOrBuilder
        Returns:
        The bytes for structuredContentUri.
      • setStructuredContentUri

        @Deprecated
        public Document.Builder setStructuredContentUri​(String value)
        Deprecated.
        google.cloud.contentwarehouse.v1.Document.structured_content_uri is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=79
         A path linked to structured content file.
         
        string structured_content_uri = 16 [deprecated = true];
        Parameters:
        value - The structuredContentUri to set.
        Returns:
        This builder for chaining.
      • clearStructuredContentUri

        @Deprecated
        public Document.Builder clearStructuredContentUri()
        Deprecated.
        google.cloud.contentwarehouse.v1.Document.structured_content_uri is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=79
         A path linked to structured content file.
         
        string structured_content_uri = 16 [deprecated = true];
        Returns:
        This builder for chaining.
      • setStructuredContentUriBytes

        @Deprecated
        public Document.Builder setStructuredContentUriBytes​(com.google.protobuf.ByteString value)
        Deprecated.
        google.cloud.contentwarehouse.v1.Document.structured_content_uri is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=79
         A path linked to structured content file.
         
        string structured_content_uri = 16 [deprecated = true];
        Parameters:
        value - The bytes for structuredContentUri to set.
        Returns:
        This builder for chaining.
      • hasRawDocumentPath

        public boolean hasRawDocumentPath()
         Raw document file in Cloud Storage path.
         
        string raw_document_path = 5;
        Specified by:
        hasRawDocumentPath in interface DocumentOrBuilder
        Returns:
        Whether the rawDocumentPath field is set.
      • getRawDocumentPath

        public String getRawDocumentPath()
         Raw document file in Cloud Storage path.
         
        string raw_document_path = 5;
        Specified by:
        getRawDocumentPath in interface DocumentOrBuilder
        Returns:
        The rawDocumentPath.
      • getRawDocumentPathBytes

        public com.google.protobuf.ByteString getRawDocumentPathBytes()
         Raw document file in Cloud Storage path.
         
        string raw_document_path = 5;
        Specified by:
        getRawDocumentPathBytes in interface DocumentOrBuilder
        Returns:
        The bytes for rawDocumentPath.
      • setRawDocumentPath

        public Document.Builder setRawDocumentPath​(String value)
         Raw document file in Cloud Storage path.
         
        string raw_document_path = 5;
        Parameters:
        value - The rawDocumentPath to set.
        Returns:
        This builder for chaining.
      • clearRawDocumentPath

        public Document.Builder clearRawDocumentPath()
         Raw document file in Cloud Storage path.
         
        string raw_document_path = 5;
        Returns:
        This builder for chaining.
      • setRawDocumentPathBytes

        public Document.Builder setRawDocumentPathBytes​(com.google.protobuf.ByteString value)
         Raw document file in Cloud Storage path.
         
        string raw_document_path = 5;
        Parameters:
        value - The bytes for rawDocumentPath to set.
        Returns:
        This builder for chaining.
      • hasInlineRawDocument

        public boolean hasInlineRawDocument()
         Raw document content.
         
        bytes inline_raw_document = 6;
        Specified by:
        hasInlineRawDocument in interface DocumentOrBuilder
        Returns:
        Whether the inlineRawDocument field is set.
      • getInlineRawDocument

        public com.google.protobuf.ByteString getInlineRawDocument()
         Raw document content.
         
        bytes inline_raw_document = 6;
        Specified by:
        getInlineRawDocument in interface DocumentOrBuilder
        Returns:
        The inlineRawDocument.
      • setInlineRawDocument

        public Document.Builder setInlineRawDocument​(com.google.protobuf.ByteString value)
         Raw document content.
         
        bytes inline_raw_document = 6;
        Parameters:
        value - The inlineRawDocument to set.
        Returns:
        This builder for chaining.
      • clearInlineRawDocument

        public Document.Builder clearInlineRawDocument()
         Raw document content.
         
        bytes inline_raw_document = 6;
        Returns:
        This builder for chaining.
      • getPropertiesList

        public List<Property> getPropertiesList()
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
        Specified by:
        getPropertiesList in interface DocumentOrBuilder
      • getPropertiesCount

        public int getPropertiesCount()
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
        Specified by:
        getPropertiesCount in interface DocumentOrBuilder
      • getProperties

        public Property getProperties​(int index)
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
        Specified by:
        getProperties in interface DocumentOrBuilder
      • setProperties

        public Document.Builder setProperties​(int index,
                                              Property value)
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • setProperties

        public Document.Builder setProperties​(int index,
                                              Property.Builder builderForValue)
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • addProperties

        public Document.Builder addProperties​(Property value)
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • addProperties

        public Document.Builder addProperties​(int index,
                                              Property value)
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • addProperties

        public Document.Builder addProperties​(Property.Builder builderForValue)
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • addProperties

        public Document.Builder addProperties​(int index,
                                              Property.Builder builderForValue)
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • addAllProperties

        public Document.Builder addAllProperties​(Iterable<? extends Property> values)
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • clearProperties

        public Document.Builder clearProperties()
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • removeProperties

        public Document.Builder removeProperties​(int index)
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • getPropertiesBuilder

        public Property.Builder getPropertiesBuilder​(int index)
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • addPropertiesBuilder

        public Property.Builder addPropertiesBuilder()
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • addPropertiesBuilder

        public Property.Builder addPropertiesBuilder​(int index)
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • getPropertiesBuilderList

        public List<Property.Builder> getPropertiesBuilderList()
         List of values that are user supplied metadata.
         
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The time when the document is last updated.
         
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface DocumentOrBuilder
        Returns:
        Whether the updateTime field is set.
      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time when the document is last updated.
         
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface DocumentOrBuilder
        Returns:
        The updateTime.
      • setUpdateTime

        public Document.Builder setUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the document is last updated.
         
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setUpdateTime

        public Document.Builder setUpdateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The time when the document is last updated.
         
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeUpdateTime

        public Document.Builder mergeUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the document is last updated.
         
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearUpdateTime

        public Document.Builder clearUpdateTime()
         Output only. The time when the document is last updated.
         
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getUpdateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
         Output only. The time when the document is last updated.
         
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time when the document is last updated.
         
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface DocumentOrBuilder
      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time when the document is created.
         
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface DocumentOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the document is created.
         
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface DocumentOrBuilder
        Returns:
        The createTime.
      • setCreateTime

        public Document.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the document is created.
         
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setCreateTime

        public Document.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The time when the document is created.
         
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeCreateTime

        public Document.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the document is created.
         
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearCreateTime

        public Document.Builder clearCreateTime()
         Output only. The time when the document is created.
         
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         Output only. The time when the document is created.
         
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the document is created.
         
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface DocumentOrBuilder
      • getRawDocumentFileTypeValue

        public int getRawDocumentFileTypeValue()
         This is used when DocAI was not used to load the document and parsing/
         extracting is needed for the inline_raw_document.  For example, if
         inline_raw_document is the byte representation of a PDF file, then
         this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
         
        .google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;
        Specified by:
        getRawDocumentFileTypeValue in interface DocumentOrBuilder
        Returns:
        The enum numeric value on the wire for rawDocumentFileType.
      • setRawDocumentFileTypeValue

        public Document.Builder setRawDocumentFileTypeValue​(int value)
         This is used when DocAI was not used to load the document and parsing/
         extracting is needed for the inline_raw_document.  For example, if
         inline_raw_document is the byte representation of a PDF file, then
         this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
         
        .google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;
        Parameters:
        value - The enum numeric value on the wire for rawDocumentFileType to set.
        Returns:
        This builder for chaining.
      • getRawDocumentFileType

        public RawDocumentFileType getRawDocumentFileType()
         This is used when DocAI was not used to load the document and parsing/
         extracting is needed for the inline_raw_document.  For example, if
         inline_raw_document is the byte representation of a PDF file, then
         this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
         
        .google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;
        Specified by:
        getRawDocumentFileType in interface DocumentOrBuilder
        Returns:
        The rawDocumentFileType.
      • setRawDocumentFileType

        public Document.Builder setRawDocumentFileType​(RawDocumentFileType value)
         This is used when DocAI was not used to load the document and parsing/
         extracting is needed for the inline_raw_document.  For example, if
         inline_raw_document is the byte representation of a PDF file, then
         this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
         
        .google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;
        Parameters:
        value - The rawDocumentFileType to set.
        Returns:
        This builder for chaining.
      • clearRawDocumentFileType

        public Document.Builder clearRawDocumentFileType()
         This is used when DocAI was not used to load the document and parsing/
         extracting is needed for the inline_raw_document.  For example, if
         inline_raw_document is the byte representation of a PDF file, then
         this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
         
        .google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;
        Returns:
        This builder for chaining.
      • getAsyncEnabled

        @Deprecated
        public boolean getAsyncEnabled()
        Deprecated.
        google.cloud.contentwarehouse.v1.Document.async_enabled is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=108
         If true, makes the document visible to asynchronous policies and rules.
         
        bool async_enabled = 12 [deprecated = true];
        Specified by:
        getAsyncEnabled in interface DocumentOrBuilder
        Returns:
        The asyncEnabled.
      • setAsyncEnabled

        @Deprecated
        public Document.Builder setAsyncEnabled​(boolean value)
        Deprecated.
        google.cloud.contentwarehouse.v1.Document.async_enabled is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=108
         If true, makes the document visible to asynchronous policies and rules.
         
        bool async_enabled = 12 [deprecated = true];
        Parameters:
        value - The asyncEnabled to set.
        Returns:
        This builder for chaining.
      • clearAsyncEnabled

        @Deprecated
        public Document.Builder clearAsyncEnabled()
        Deprecated.
        google.cloud.contentwarehouse.v1.Document.async_enabled is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=108
         If true, makes the document visible to asynchronous policies and rules.
         
        bool async_enabled = 12 [deprecated = true];
        Returns:
        This builder for chaining.
      • getContentCategoryValue

        public int getContentCategoryValue()
         Indicates the category (image, audio, video etc.) of the original content.
         
        .google.cloud.contentwarehouse.v1.ContentCategory content_category = 20;
        Specified by:
        getContentCategoryValue in interface DocumentOrBuilder
        Returns:
        The enum numeric value on the wire for contentCategory.
      • setContentCategoryValue

        public Document.Builder setContentCategoryValue​(int value)
         Indicates the category (image, audio, video etc.) of the original content.
         
        .google.cloud.contentwarehouse.v1.ContentCategory content_category = 20;
        Parameters:
        value - The enum numeric value on the wire for contentCategory to set.
        Returns:
        This builder for chaining.
      • getContentCategory

        public ContentCategory getContentCategory()
         Indicates the category (image, audio, video etc.) of the original content.
         
        .google.cloud.contentwarehouse.v1.ContentCategory content_category = 20;
        Specified by:
        getContentCategory in interface DocumentOrBuilder
        Returns:
        The contentCategory.
      • setContentCategory

        public Document.Builder setContentCategory​(ContentCategory value)
         Indicates the category (image, audio, video etc.) of the original content.
         
        .google.cloud.contentwarehouse.v1.ContentCategory content_category = 20;
        Parameters:
        value - The contentCategory to set.
        Returns:
        This builder for chaining.
      • clearContentCategory

        public Document.Builder clearContentCategory()
         Indicates the category (image, audio, video etc.) of the original content.
         
        .google.cloud.contentwarehouse.v1.ContentCategory content_category = 20;
        Returns:
        This builder for chaining.
      • getTextExtractionDisabled

        @Deprecated
        public boolean getTextExtractionDisabled()
        Deprecated.
        google.cloud.contentwarehouse.v1.Document.text_extraction_disabled is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=114
         If true, text extraction will not be performed.
         
        bool text_extraction_disabled = 19 [deprecated = true];
        Specified by:
        getTextExtractionDisabled in interface DocumentOrBuilder
        Returns:
        The textExtractionDisabled.
      • setTextExtractionDisabled

        @Deprecated
        public Document.Builder setTextExtractionDisabled​(boolean value)
        Deprecated.
        google.cloud.contentwarehouse.v1.Document.text_extraction_disabled is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=114
         If true, text extraction will not be performed.
         
        bool text_extraction_disabled = 19 [deprecated = true];
        Parameters:
        value - The textExtractionDisabled to set.
        Returns:
        This builder for chaining.
      • clearTextExtractionDisabled

        @Deprecated
        public Document.Builder clearTextExtractionDisabled()
        Deprecated.
        google.cloud.contentwarehouse.v1.Document.text_extraction_disabled is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=114
         If true, text extraction will not be performed.
         
        bool text_extraction_disabled = 19 [deprecated = true];
        Returns:
        This builder for chaining.
      • getTextExtractionEnabled

        public boolean getTextExtractionEnabled()
         If true, text extraction will be performed.
         
        bool text_extraction_enabled = 21;
        Specified by:
        getTextExtractionEnabled in interface DocumentOrBuilder
        Returns:
        The textExtractionEnabled.
      • setTextExtractionEnabled

        public Document.Builder setTextExtractionEnabled​(boolean value)
         If true, text extraction will be performed.
         
        bool text_extraction_enabled = 21;
        Parameters:
        value - The textExtractionEnabled to set.
        Returns:
        This builder for chaining.
      • clearTextExtractionEnabled

        public Document.Builder clearTextExtractionEnabled()
         If true, text extraction will be performed.
         
        bool text_extraction_enabled = 21;
        Returns:
        This builder for chaining.
      • getCreator

        public String getCreator()
         The user who creates the document.
         
        string creator = 13;
        Specified by:
        getCreator in interface DocumentOrBuilder
        Returns:
        The creator.
      • getCreatorBytes

        public com.google.protobuf.ByteString getCreatorBytes()
         The user who creates the document.
         
        string creator = 13;
        Specified by:
        getCreatorBytes in interface DocumentOrBuilder
        Returns:
        The bytes for creator.
      • setCreator

        public Document.Builder setCreator​(String value)
         The user who creates the document.
         
        string creator = 13;
        Parameters:
        value - The creator to set.
        Returns:
        This builder for chaining.
      • clearCreator

        public Document.Builder clearCreator()
         The user who creates the document.
         
        string creator = 13;
        Returns:
        This builder for chaining.
      • setCreatorBytes

        public Document.Builder setCreatorBytes​(com.google.protobuf.ByteString value)
         The user who creates the document.
         
        string creator = 13;
        Parameters:
        value - The bytes for creator to set.
        Returns:
        This builder for chaining.
      • getUpdater

        public String getUpdater()
         The user who lastly updates the document.
         
        string updater = 14;
        Specified by:
        getUpdater in interface DocumentOrBuilder
        Returns:
        The updater.
      • getUpdaterBytes

        public com.google.protobuf.ByteString getUpdaterBytes()
         The user who lastly updates the document.
         
        string updater = 14;
        Specified by:
        getUpdaterBytes in interface DocumentOrBuilder
        Returns:
        The bytes for updater.
      • setUpdater

        public Document.Builder setUpdater​(String value)
         The user who lastly updates the document.
         
        string updater = 14;
        Parameters:
        value - The updater to set.
        Returns:
        This builder for chaining.
      • clearUpdater

        public Document.Builder clearUpdater()
         The user who lastly updates the document.
         
        string updater = 14;
        Returns:
        This builder for chaining.
      • setUpdaterBytes

        public Document.Builder setUpdaterBytes​(com.google.protobuf.ByteString value)
         The user who lastly updates the document.
         
        string updater = 14;
        Parameters:
        value - The bytes for updater to set.
        Returns:
        This builder for chaining.
      • hasDispositionTime

        public boolean hasDispositionTime()
         Output only. If linked to a Collection with RetentionPolicy, the date when
         the document becomes mutable.
         
        .google.protobuf.Timestamp disposition_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDispositionTime in interface DocumentOrBuilder
        Returns:
        Whether the dispositionTime field is set.
      • getDispositionTime

        public com.google.protobuf.Timestamp getDispositionTime()
         Output only. If linked to a Collection with RetentionPolicy, the date when
         the document becomes mutable.
         
        .google.protobuf.Timestamp disposition_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDispositionTime in interface DocumentOrBuilder
        Returns:
        The dispositionTime.
      • setDispositionTime

        public Document.Builder setDispositionTime​(com.google.protobuf.Timestamp value)
         Output only. If linked to a Collection with RetentionPolicy, the date when
         the document becomes mutable.
         
        .google.protobuf.Timestamp disposition_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setDispositionTime

        public Document.Builder setDispositionTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. If linked to a Collection with RetentionPolicy, the date when
         the document becomes mutable.
         
        .google.protobuf.Timestamp disposition_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeDispositionTime

        public Document.Builder mergeDispositionTime​(com.google.protobuf.Timestamp value)
         Output only. If linked to a Collection with RetentionPolicy, the date when
         the document becomes mutable.
         
        .google.protobuf.Timestamp disposition_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearDispositionTime

        public Document.Builder clearDispositionTime()
         Output only. If linked to a Collection with RetentionPolicy, the date when
         the document becomes mutable.
         
        .google.protobuf.Timestamp disposition_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getDispositionTimeBuilder

        public com.google.protobuf.Timestamp.Builder getDispositionTimeBuilder()
         Output only. If linked to a Collection with RetentionPolicy, the date when
         the document becomes mutable.
         
        .google.protobuf.Timestamp disposition_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getDispositionTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getDispositionTimeOrBuilder()
         Output only. If linked to a Collection with RetentionPolicy, the date when
         the document becomes mutable.
         
        .google.protobuf.Timestamp disposition_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDispositionTimeOrBuilder in interface DocumentOrBuilder
      • getLegalHold

        public boolean getLegalHold()
         Output only. Indicates if the document has a legal hold on it.
         
        bool legal_hold = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLegalHold in interface DocumentOrBuilder
        Returns:
        The legalHold.
      • setLegalHold

        public Document.Builder setLegalHold​(boolean value)
         Output only. Indicates if the document has a legal hold on it.
         
        bool legal_hold = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The legalHold to set.
        Returns:
        This builder for chaining.
      • clearLegalHold

        public Document.Builder clearLegalHold()
         Output only. Indicates if the document has a legal hold on it.
         
        bool legal_hold = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final Document.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
      • mergeUnknownFields

        public final Document.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>