Package com.google.cloud.contentwarehouse.v1

Interface DocumentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Document, Document.Builder
    public interface DocumentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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;
        Returns:
        The name.

      • getNameBytes

        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;
        Returns:
        The bytes for name.

      • getReferenceId

        String getReferenceId()
         The reference ID set by customers. Must be unique per project and location.
        string reference_id = 11;
        Returns:
        The referenceId.

      • getReferenceIdBytes

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

      • getDisplayName

        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];
        Returns:
        The displayName.

      • getDisplayNameBytes

        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];
        Returns:
        The bytes for displayName.

      • getTitle

        String getTitle()
         Title that describes the document.
 This can be the top heading or text that describes the document.
        string title = 18;
        Returns:
        The title.

      • getTitleBytes

        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;
        Returns:
        The bytes for title.

      • getDisplayUri

        String getDisplayUri()
         Uri to display the document, for example, in the UI.
        string display_uri = 17;
        Returns:
        The displayUri.

      • getDisplayUriBytes

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

      • getDocumentSchemaName

        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) = { ... }
        Returns:
        The documentSchemaName.

      • getDocumentSchemaNameBytes

        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) = { ... }
        Returns:
        The bytes for documentSchemaName.

      • hasPlainText

        boolean hasPlainText()
         Other document format, such as PPTX, XLXS
        string plain_text = 15;
        Returns:
        Whether the plainText field is set.

      • getPlainText

        String getPlainText()
         Other document format, such as PPTX, XLXS
        string plain_text = 15;
        Returns:
        The plainText.

      • getPlainTextBytes

        com.google.protobuf.ByteString getPlainTextBytes()
         Other document format, such as PPTX, XLXS
        string plain_text = 15;
        Returns:
        The bytes for plainText.

      • hasCloudAiDocument

        boolean hasCloudAiDocument()
         Document AI format to save the structured content, including OCR.
        .google.cloud.documentai.v1.Document cloud_ai_document = 4;
        Returns:
        Whether the cloudAiDocument field is set.

      • getCloudAiDocument

        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;
        Returns:
        The cloudAiDocument.

      • getCloudAiDocumentOrBuilder

        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;

      • getStructuredContentUri

        @Deprecated
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];
        Returns:
        The structuredContentUri.

      • getStructuredContentUriBytes

        @Deprecated
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];
        Returns:
        The bytes for structuredContentUri.

      • hasRawDocumentPath

        boolean hasRawDocumentPath()
         Raw document file in Cloud Storage path.
        string raw_document_path = 5;
        Returns:
        Whether the rawDocumentPath field is set.

      • getRawDocumentPath

        String getRawDocumentPath()
         Raw document file in Cloud Storage path.
        string raw_document_path = 5;
        Returns:
        The rawDocumentPath.

      • getRawDocumentPathBytes

        com.google.protobuf.ByteString getRawDocumentPathBytes()
         Raw document file in Cloud Storage path.
        string raw_document_path = 5;
        Returns:
        The bytes for rawDocumentPath.

      • hasInlineRawDocument

        boolean hasInlineRawDocument()
         Raw document content.
        bytes inline_raw_document = 6;
        Returns:
        Whether the inlineRawDocument field is set.

      • getInlineRawDocument

        com.google.protobuf.ByteString getInlineRawDocument()
         Raw document content.
        bytes inline_raw_document = 6;
        Returns:
        The inlineRawDocument.

      • getPropertiesList

        List<Property> getPropertiesList()
         List of values that are user supplied metadata.
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

      • getProperties

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

      • getPropertiesCount

        int getPropertiesCount()
         List of values that are user supplied metadata.
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

      • getPropertiesOrBuilderList

        List<? extends PropertyOrBuilder> getPropertiesOrBuilderList()
         List of values that are user supplied metadata.
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

      • getPropertiesOrBuilder

        PropertyOrBuilder getPropertiesOrBuilder​(int index)
         List of values that are user supplied metadata.
        repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

      • hasUpdateTime

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

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        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];

      • hasCreateTime

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

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        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];

      • getRawDocumentFileTypeValue

        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;
        Returns:
        The enum numeric value on the wire for rawDocumentFileType.

      • getRawDocumentFileType

        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;
        Returns:
        The rawDocumentFileType.

      • getAsyncEnabled

        @Deprecated
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];
        Returns:
        The asyncEnabled.

      • getContentCategoryValue

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

      • getContentCategory

        ContentCategory getContentCategory()
         Indicates the category (image, audio, video etc.) of the original content.
        .google.cloud.contentwarehouse.v1.ContentCategory content_category = 20;
        Returns:
        The contentCategory.

      • getTextExtractionDisabled

        @Deprecated
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];
        Returns:
        The textExtractionDisabled.

      • getTextExtractionEnabled

        boolean getTextExtractionEnabled()
         If true, text extraction will be performed.
        bool text_extraction_enabled = 21;
        Returns:
        The textExtractionEnabled.

      • getCreator

        String getCreator()
         The user who creates the document.
        string creator = 13;
        Returns:
        The creator.

      • getCreatorBytes

        com.google.protobuf.ByteString getCreatorBytes()
         The user who creates the document.
        string creator = 13;
        Returns:
        The bytes for creator.

      • getUpdater

        String getUpdater()
         The user who lastly updates the document.
        string updater = 14;
        Returns:
        The updater.

      • getUpdaterBytes

        com.google.protobuf.ByteString getUpdaterBytes()
         The user who lastly updates the document.
        string updater = 14;
        Returns:
        The bytes for updater.

      • hasDispositionTime

        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];
        Returns:
        Whether the dispositionTime field is set.

      • getDispositionTime

        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];
        Returns:
        The dispositionTime.

      • getDispositionTimeOrBuilder

        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];

      • getLegalHold

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