Package com.google.cloud.contentwarehouse.v1

Class Document

  • All Implemented Interfaces:
    DocumentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Document
extends com.google.protobuf.GeneratedMessageV3
implements DocumentOrBuilder
     Defines the structure for content warehouse document proto.
    Protobuf type google.cloud.contentwarehouse.v1.Document
    See Also:
    Serialized Form

    • Field Detail

      • REFERENCE_ID_FIELD_NUMBER

        public static final int REFERENCE_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPLAY_URI_FIELD_NUMBER

        public static final int DISPLAY_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_SCHEMA_NAME_FIELD_NUMBER

        public static final int DOCUMENT_SCHEMA_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PLAIN_TEXT_FIELD_NUMBER

        public static final int PLAIN_TEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLOUD_AI_DOCUMENT_FIELD_NUMBER

        public static final int CLOUD_AI_DOCUMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STRUCTURED_CONTENT_URI_FIELD_NUMBER

        public static final int STRUCTURED_CONTENT_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RAW_DOCUMENT_PATH_FIELD_NUMBER

        public static final int RAW_DOCUMENT_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INLINE_RAW_DOCUMENT_FIELD_NUMBER

        public static final int INLINE_RAW_DOCUMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROPERTIES_FIELD_NUMBER

        public static final int PROPERTIES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RAW_DOCUMENT_FILE_TYPE_FIELD_NUMBER

        public static final int RAW_DOCUMENT_FILE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ASYNC_ENABLED_FIELD_NUMBER

        public static final int ASYNC_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONTENT_CATEGORY_FIELD_NUMBER

        public static final int CONTENT_CATEGORY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEXT_EXTRACTION_DISABLED_FIELD_NUMBER

        public static final int TEXT_EXTRACTION_DISABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEXT_EXTRACTION_ENABLED_FIELD_NUMBER

        public static final int TEXT_EXTRACTION_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPOSITION_TIME_FIELD_NUMBER

        public static final int DISPOSITION_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LEGAL_HOLD_FIELD_NUMBER

        public static final int LEGAL_HOLD_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()
         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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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 Document parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Document parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Document getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Document> parser()

      • getParserForType

        public com.google.protobuf.Parser<Document> 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 Document getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder