/*
* 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/documentai/v1beta3/document.proto
package com.google.cloud.documentai.v1beta3;
public interface DocumentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.documentai.v1beta3.Document)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Optional. Currently supports Google Cloud Storage URI of the form
* `gs://bucket_name/object_name`. Object versioning is not supported.
* See [Google Cloud Storage Request
* URIs](https://cloud.google.com/storage/docs/reference-uris) for more
* info.
*
*
* string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return Whether the uri field is set.
*/
boolean hasUri();
/**
*
*
*
* Optional. Currently supports Google Cloud Storage URI of the form
* `gs://bucket_name/object_name`. Object versioning is not supported.
* See [Google Cloud Storage Request
* URIs](https://cloud.google.com/storage/docs/reference-uris) for more
* info.
*
*
* string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The uri.
*/
java.lang.String getUri();
/**
*
*
*
* Optional. Currently supports Google Cloud Storage URI of the form
* `gs://bucket_name/object_name`. Object versioning is not supported.
* See [Google Cloud Storage Request
* URIs](https://cloud.google.com/storage/docs/reference-uris) for more
* info.
*
*
* string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for uri.
*/
com.google.protobuf.ByteString getUriBytes();
/**
*
*
*
* Optional. Inline document content, represented as a stream of bytes.
* Note: As with all `bytes` fields, protobuffers use a pure binary
* representation, whereas JSON representations use base64.
*
*
* bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return Whether the content field is set.
*/
boolean hasContent();
/**
*
*
*
* Optional. Inline document content, represented as a stream of bytes.
* Note: As with all `bytes` fields, protobuffers use a pure binary
* representation, whereas JSON representations use base64.
*
*
* bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The content.
*/
com.google.protobuf.ByteString getContent();
/**
*
*
*
* An IANA published MIME type (also referred to as media type). For more
* information, see
* https://www.iana.org/assignments/media-types/media-types.xhtml.
*
*
* string mime_type = 3;
*
* @return The mimeType.
*/
java.lang.String getMimeType();
/**
*
*
*
* An IANA published MIME type (also referred to as media type). For more
* information, see
* https://www.iana.org/assignments/media-types/media-types.xhtml.
*
*
* string mime_type = 3;
*
* @return The bytes for mimeType.
*/
com.google.protobuf.ByteString getMimeTypeBytes();
/**
*
*
*
* Optional. UTF-8 encoded text in reading order from the document.
*
*
* string text = 4 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The text.
*/
java.lang.String getText();
/**
*
*
*
* Optional. UTF-8 encoded text in reading order from the document.
*
*
* string text = 4 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for text.
*/
com.google.protobuf.ByteString getTextBytes();
/**
*
*
*
* Styles for the
* [Document.text][google.cloud.documentai.v1beta3.Document.text].
*
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Style text_styles = 5 [deprecated = true];
*
*/
@java.lang.Deprecated
java.util.List getTextStylesList();
/**
*
*
*
* Styles for the
* [Document.text][google.cloud.documentai.v1beta3.Document.text].
*
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Style text_styles = 5 [deprecated = true];
*
*/
@java.lang.Deprecated
com.google.cloud.documentai.v1beta3.Document.Style getTextStyles(int index);
/**
*
*
*
* Styles for the
* [Document.text][google.cloud.documentai.v1beta3.Document.text].
*
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Style text_styles = 5 [deprecated = true];
*
*/
@java.lang.Deprecated
int getTextStylesCount();
/**
*
*
*
* Styles for the
* [Document.text][google.cloud.documentai.v1beta3.Document.text].
*
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Style text_styles = 5 [deprecated = true];
*
*/
@java.lang.Deprecated
java.util.List
getTextStylesOrBuilderList();
/**
*
*
*
* Styles for the
* [Document.text][google.cloud.documentai.v1beta3.Document.text].
*
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Style text_styles = 5 [deprecated = true];
*
*/
@java.lang.Deprecated
com.google.cloud.documentai.v1beta3.Document.StyleOrBuilder getTextStylesOrBuilder(int index);
/**
*
*
*
* Visual page layout for the
* [Document][google.cloud.documentai.v1beta3.Document].
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Page pages = 6;
*/
java.util.List getPagesList();
/**
*
*
*
* Visual page layout for the
* [Document][google.cloud.documentai.v1beta3.Document].
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Page pages = 6;
*/
com.google.cloud.documentai.v1beta3.Document.Page getPages(int index);
/**
*
*
*
* Visual page layout for the
* [Document][google.cloud.documentai.v1beta3.Document].
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Page pages = 6;
*/
int getPagesCount();
/**
*
*
*
* Visual page layout for the
* [Document][google.cloud.documentai.v1beta3.Document].
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Page pages = 6;
*/
java.util.List
getPagesOrBuilderList();
/**
*
*
*
* Visual page layout for the
* [Document][google.cloud.documentai.v1beta3.Document].
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Page pages = 6;
*/
com.google.cloud.documentai.v1beta3.Document.PageOrBuilder getPagesOrBuilder(int index);
/**
*
*
*
* A list of entities detected on
* [Document.text][google.cloud.documentai.v1beta3.Document.text]. For
* document shards, entities in this list may cross shard boundaries.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Entity entities = 7;
*/
java.util.List getEntitiesList();
/**
*
*
*
* A list of entities detected on
* [Document.text][google.cloud.documentai.v1beta3.Document.text]. For
* document shards, entities in this list may cross shard boundaries.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Entity entities = 7;
*/
com.google.cloud.documentai.v1beta3.Document.Entity getEntities(int index);
/**
*
*
*
* A list of entities detected on
* [Document.text][google.cloud.documentai.v1beta3.Document.text]. For
* document shards, entities in this list may cross shard boundaries.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Entity entities = 7;
*/
int getEntitiesCount();
/**
*
*
*
* A list of entities detected on
* [Document.text][google.cloud.documentai.v1beta3.Document.text]. For
* document shards, entities in this list may cross shard boundaries.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Entity entities = 7;
*/
java.util.List
getEntitiesOrBuilderList();
/**
*
*
*
* A list of entities detected on
* [Document.text][google.cloud.documentai.v1beta3.Document.text]. For
* document shards, entities in this list may cross shard boundaries.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Entity entities = 7;
*/
com.google.cloud.documentai.v1beta3.Document.EntityOrBuilder getEntitiesOrBuilder(int index);
/**
*
*
*
* Placeholder. Relationship among
* [Document.entities][google.cloud.documentai.v1beta3.Document.entities].
*
*
* repeated .google.cloud.documentai.v1beta3.Document.EntityRelation entity_relations = 8;
*
*/
java.util.List
getEntityRelationsList();
/**
*
*
*
* Placeholder. Relationship among
* [Document.entities][google.cloud.documentai.v1beta3.Document.entities].
*
*
* repeated .google.cloud.documentai.v1beta3.Document.EntityRelation entity_relations = 8;
*
*/
com.google.cloud.documentai.v1beta3.Document.EntityRelation getEntityRelations(int index);
/**
*
*
*
* Placeholder. Relationship among
* [Document.entities][google.cloud.documentai.v1beta3.Document.entities].
*
*
* repeated .google.cloud.documentai.v1beta3.Document.EntityRelation entity_relations = 8;
*
*/
int getEntityRelationsCount();
/**
*
*
*
* Placeholder. Relationship among
* [Document.entities][google.cloud.documentai.v1beta3.Document.entities].
*
*
* repeated .google.cloud.documentai.v1beta3.Document.EntityRelation entity_relations = 8;
*
*/
java.util.List
getEntityRelationsOrBuilderList();
/**
*
*
*
* Placeholder. Relationship among
* [Document.entities][google.cloud.documentai.v1beta3.Document.entities].
*
*
* repeated .google.cloud.documentai.v1beta3.Document.EntityRelation entity_relations = 8;
*
*/
com.google.cloud.documentai.v1beta3.Document.EntityRelationOrBuilder getEntityRelationsOrBuilder(
int index);
/**
*
*
*
* Placeholder. A list of text corrections made to
* [Document.text][google.cloud.documentai.v1beta3.Document.text]. This is
* usually used for annotating corrections to OCR mistakes. Text changes for
* a given revision may not overlap with each other.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.TextChange text_changes = 14;
*/
java.util.List getTextChangesList();
/**
*
*
*
* Placeholder. A list of text corrections made to
* [Document.text][google.cloud.documentai.v1beta3.Document.text]. This is
* usually used for annotating corrections to OCR mistakes. Text changes for
* a given revision may not overlap with each other.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.TextChange text_changes = 14;
*/
com.google.cloud.documentai.v1beta3.Document.TextChange getTextChanges(int index);
/**
*
*
*
* Placeholder. A list of text corrections made to
* [Document.text][google.cloud.documentai.v1beta3.Document.text]. This is
* usually used for annotating corrections to OCR mistakes. Text changes for
* a given revision may not overlap with each other.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.TextChange text_changes = 14;
*/
int getTextChangesCount();
/**
*
*
*
* Placeholder. A list of text corrections made to
* [Document.text][google.cloud.documentai.v1beta3.Document.text]. This is
* usually used for annotating corrections to OCR mistakes. Text changes for
* a given revision may not overlap with each other.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.TextChange text_changes = 14;
*/
java.util.List
getTextChangesOrBuilderList();
/**
*
*
*
* Placeholder. A list of text corrections made to
* [Document.text][google.cloud.documentai.v1beta3.Document.text]. This is
* usually used for annotating corrections to OCR mistakes. Text changes for
* a given revision may not overlap with each other.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.TextChange text_changes = 14;
*/
com.google.cloud.documentai.v1beta3.Document.TextChangeOrBuilder getTextChangesOrBuilder(
int index);
/**
*
*
*
* Information about the sharding if this document is sharded part of a larger
* document. If the document is not sharded, this message is not specified.
*
*
* .google.cloud.documentai.v1beta3.Document.ShardInfo shard_info = 9;
*
* @return Whether the shardInfo field is set.
*/
boolean hasShardInfo();
/**
*
*
*
* Information about the sharding if this document is sharded part of a larger
* document. If the document is not sharded, this message is not specified.
*
*
* .google.cloud.documentai.v1beta3.Document.ShardInfo shard_info = 9;
*
* @return The shardInfo.
*/
com.google.cloud.documentai.v1beta3.Document.ShardInfo getShardInfo();
/**
*
*
*
* Information about the sharding if this document is sharded part of a larger
* document. If the document is not sharded, this message is not specified.
*
*
* .google.cloud.documentai.v1beta3.Document.ShardInfo shard_info = 9;
*/
com.google.cloud.documentai.v1beta3.Document.ShardInfoOrBuilder getShardInfoOrBuilder();
/**
*
*
*
* Any error that occurred while processing this document.
*
*
* .google.rpc.Status error = 10;
*
* @return Whether the error field is set.
*/
boolean hasError();
/**
*
*
*
* Any error that occurred while processing this document.
*
*
* .google.rpc.Status error = 10;
*
* @return The error.
*/
com.google.rpc.Status getError();
/**
*
*
*
* Any error that occurred while processing this document.
*
*
* .google.rpc.Status error = 10;
*/
com.google.rpc.StatusOrBuilder getErrorOrBuilder();
/**
*
*
*
* Placeholder. Revision history of this document.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Revision revisions = 13;
*/
java.util.List getRevisionsList();
/**
*
*
*
* Placeholder. Revision history of this document.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Revision revisions = 13;
*/
com.google.cloud.documentai.v1beta3.Document.Revision getRevisions(int index);
/**
*
*
*
* Placeholder. Revision history of this document.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Revision revisions = 13;
*/
int getRevisionsCount();
/**
*
*
*
* Placeholder. Revision history of this document.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Revision revisions = 13;
*/
java.util.List
getRevisionsOrBuilderList();
/**
*
*
*
* Placeholder. Revision history of this document.
*
*
* repeated .google.cloud.documentai.v1beta3.Document.Revision revisions = 13;
*/
com.google.cloud.documentai.v1beta3.Document.RevisionOrBuilder getRevisionsOrBuilder(int index);
public com.google.cloud.documentai.v1beta3.Document.SourceCase getSourceCase();
}