/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/contentwarehouse/v1/document.proto
package com.google.cloud.contentwarehouse.v1;
public interface DocumentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.contentwarehouse.v1.Document)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*
* @return The name.
*/
java.lang.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;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The reference ID set by customers. Must be unique per project and location.
*
*
* string reference_id = 11;
*
* @return The referenceId.
*/
java.lang.String getReferenceId();
/**
*
*
*
* The reference ID set by customers. Must be unique per project and location.
*
*
* string reference_id = 11;
*
* @return The bytes for referenceId.
*/
com.google.protobuf.ByteString getReferenceIdBytes();
/**
*
*
*
* 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];
*
* @return The displayName.
*/
java.lang.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];
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Title that describes the document.
* This can be the top heading or text that describes the document.
*
*
* string title = 18;
*
* @return The title.
*/
java.lang.String getTitle();
/**
*
*
*
* Title that describes the document.
* This can be the top heading or text that describes the document.
*
*
* string title = 18;
*
* @return The bytes for title.
*/
com.google.protobuf.ByteString getTitleBytes();
/**
*
*
*
* Uri to display the document, for example, in the UI.
*
*
* string display_uri = 17;
*
* @return The displayUri.
*/
java.lang.String getDisplayUri();
/**
*
*
*
* Uri to display the document, for example, in the UI.
*
*
* string display_uri = 17;
*
* @return The bytes for displayUri.
*/
com.google.protobuf.ByteString getDisplayUriBytes();
/**
*
*
*
* The Document schema name.
* Format:
* projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
*
*
* string document_schema_name = 3 [(.google.api.resource_reference) = { ... }
*
* @return The documentSchemaName.
*/
java.lang.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) = { ... }
*
* @return The bytes for documentSchemaName.
*/
com.google.protobuf.ByteString getDocumentSchemaNameBytes();
/**
*
*
*
* Other document format, such as PPTX, XLXS
*
*
* string plain_text = 15;
*
* @return Whether the plainText field is set.
*/
boolean hasPlainText();
/**
*
*
*
* Other document format, such as PPTX, XLXS
*
*
* string plain_text = 15;
*
* @return The plainText.
*/
java.lang.String getPlainText();
/**
*
*
*
* Other document format, such as PPTX, XLXS
*
*
* string plain_text = 15;
*
* @return The bytes for plainText.
*/
com.google.protobuf.ByteString getPlainTextBytes();
/**
*
*
*
* Document AI format to save the structured content, including OCR.
*
*
* .google.cloud.documentai.v1.Document cloud_ai_document = 4;
*
* @return Whether the cloudAiDocument field is set.
*/
boolean hasCloudAiDocument();
/**
*
*
*
* Document AI format to save the structured content, including OCR.
*
*
* .google.cloud.documentai.v1.Document cloud_ai_document = 4;
*
* @return The cloudAiDocument.
*/
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;
*/
com.google.cloud.documentai.v1.DocumentOrBuilder getCloudAiDocumentOrBuilder();
/**
*
*
*
* A path linked to structured content file.
*
*
* string structured_content_uri = 16 [deprecated = true];
*
* @deprecated google.cloud.contentwarehouse.v1.Document.structured_content_uri is deprecated. See
* google/cloud/contentwarehouse/v1/document.proto;l=79
* @return The structuredContentUri.
*/
@java.lang.Deprecated
java.lang.String getStructuredContentUri();
/**
*
*
*
* A path linked to structured content file.
*
*
* string structured_content_uri = 16 [deprecated = true];
*
* @deprecated google.cloud.contentwarehouse.v1.Document.structured_content_uri is deprecated. See
* google/cloud/contentwarehouse/v1/document.proto;l=79
* @return The bytes for structuredContentUri.
*/
@java.lang.Deprecated
com.google.protobuf.ByteString getStructuredContentUriBytes();
/**
*
*
*
* Raw document file in Cloud Storage path.
*
*
* string raw_document_path = 5;
*
* @return Whether the rawDocumentPath field is set.
*/
boolean hasRawDocumentPath();
/**
*
*
*
* Raw document file in Cloud Storage path.
*
*
* string raw_document_path = 5;
*
* @return The rawDocumentPath.
*/
java.lang.String getRawDocumentPath();
/**
*
*
*
* Raw document file in Cloud Storage path.
*
*
* string raw_document_path = 5;
*
* @return The bytes for rawDocumentPath.
*/
com.google.protobuf.ByteString getRawDocumentPathBytes();
/**
*
*
*
* Raw document content.
*
*
* bytes inline_raw_document = 6;
*
* @return Whether the inlineRawDocument field is set.
*/
boolean hasInlineRawDocument();
/**
*
*
*
* Raw document content.
*
*
* bytes inline_raw_document = 6;
*
* @return The inlineRawDocument.
*/
com.google.protobuf.ByteString getInlineRawDocument();
/**
*
*
*
* List of values that are user supplied metadata.
*
*
* repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
*/
java.util.List getPropertiesList();
/**
*
*
*
* List of values that are user supplied metadata.
*
*
* repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
*/
com.google.cloud.contentwarehouse.v1.Property getProperties(int index);
/**
*
*
*
* List of values that are user supplied metadata.
*
*
* repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
*/
int getPropertiesCount();
/**
*
*
*
* List of values that are user supplied metadata.
*
*
* repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
*/
java.util.List
getPropertiesOrBuilderList();
/**
*
*
*
* List of values that are user supplied metadata.
*
*
* repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
*/
com.google.cloud.contentwarehouse.v1.PropertyOrBuilder getPropertiesOrBuilder(int index);
/**
*
*
*
* Output only. The time when the document is last updated.
*
*
* .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The time when the document is last updated.
*
*
* .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Output only. The time when the document is created.
*
*
* .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time when the document is created.
*
*
* .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* 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;
*
* @return The enum numeric value on the wire for rawDocumentFileType.
*/
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;
*
* @return The rawDocumentFileType.
*/
com.google.cloud.contentwarehouse.v1.RawDocumentFileType getRawDocumentFileType();
/**
*
*
*
* If true, makes the document visible to asynchronous policies and rules.
*
*
* bool async_enabled = 12 [deprecated = true];
*
* @deprecated google.cloud.contentwarehouse.v1.Document.async_enabled is deprecated. See
* google/cloud/contentwarehouse/v1/document.proto;l=108
* @return The asyncEnabled.
*/
@java.lang.Deprecated
boolean getAsyncEnabled();
/**
*
*
*
* Indicates the category (image, audio, video etc.) of the original content.
*
*
* .google.cloud.contentwarehouse.v1.ContentCategory content_category = 20;
*
* @return The enum numeric value on the wire for contentCategory.
*/
int getContentCategoryValue();
/**
*
*
*
* Indicates the category (image, audio, video etc.) of the original content.
*
*
* .google.cloud.contentwarehouse.v1.ContentCategory content_category = 20;
*
* @return The contentCategory.
*/
com.google.cloud.contentwarehouse.v1.ContentCategory getContentCategory();
/**
*
*
*
* If true, text extraction will not be performed.
*
*
* bool text_extraction_disabled = 19 [deprecated = true];
*
* @deprecated google.cloud.contentwarehouse.v1.Document.text_extraction_disabled is deprecated.
* See google/cloud/contentwarehouse/v1/document.proto;l=114
* @return The textExtractionDisabled.
*/
@java.lang.Deprecated
boolean getTextExtractionDisabled();
/**
*
*
*
* If true, text extraction will be performed.
*
*
* bool text_extraction_enabled = 21;
*
* @return The textExtractionEnabled.
*/
boolean getTextExtractionEnabled();
/**
*
*
*
* The user who creates the document.
*
*
* string creator = 13;
*
* @return The creator.
*/
java.lang.String getCreator();
/**
*
*
*
* The user who creates the document.
*
*
* string creator = 13;
*
* @return The bytes for creator.
*/
com.google.protobuf.ByteString getCreatorBytes();
/**
*
*
*
* The user who lastly updates the document.
*
*
* string updater = 14;
*
* @return The updater.
*/
java.lang.String getUpdater();
/**
*
*
*
* The user who lastly updates the document.
*
*
* string updater = 14;
*
* @return The bytes for updater.
*/
com.google.protobuf.ByteString getUpdaterBytes();
public com.google.cloud.contentwarehouse.v1.Document.StructuredContentCase
getStructuredContentCase();
public com.google.cloud.contentwarehouse.v1.Document.RawDocumentCase getRawDocumentCase();
}