Package com.google.cloud.documentai.v1

Class Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

All Implemented Interfaces:

Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Document.DocumentLayout.DocumentLayoutBlock

public static final class Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock
extends com.google.protobuf.GeneratedMessage
implements Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

 Represents an image type block.
 

Protobuf type google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder	Represents an image type block.
static enum	Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.ImageSourceCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ANNOTATIONS_FIELD_NUMBER
static final int	BLOB_ASSET_ID_FIELD_NUMBER
static final int	DATA_URI_FIELD_NUMBER
static final int	GCS_URI_FIELD_NUMBER
static final int	IMAGE_TEXT_FIELD_NUMBER
static final int	MIME_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Document.Annotations	getAnnotations()	Annotation of the image block.
Document.AnnotationsOrBuilder	getAnnotationsOrBuilder()	Annotation of the image block.
String	getBlobAssetId()	Optional.
com.google.protobuf.ByteString	getBlobAssetIdBytes()	Optional.
String	getDataUri()	Optional.
com.google.protobuf.ByteString	getDataUriBytes()	Optional.
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	getDefaultInstance()
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getGcsUri()	Optional.
com.google.protobuf.ByteString	getGcsUriBytes()	Optional.
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.ImageSourceCase	getImageSourceCase()
String	getImageText()	Text extracted from the image using OCR or alt text describing the image.
com.google.protobuf.ByteString	getImageTextBytes()	Text extracted from the image using OCR or alt text describing the image.
String	getMimeType()	Mime type of the image.
com.google.protobuf.ByteString	getMimeTypeBytes()	Mime type of the image.
com.google.protobuf.Parser<Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock>	getParserForType()
int	getSerializedSize()
boolean	hasAnnotations()	Annotation of the image block.
boolean	hasBlobAssetId()	Optional.
boolean	hasDataUri()	Optional.
boolean	hasGcsUri()	Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder	newBuilder()
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder	newBuilder(Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock prototype)
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder	newBuilderForType()
protected Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseDelimitedFrom(InputStream input)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseFrom(byte[] data)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseFrom(com.google.protobuf.ByteString data)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseFrom(com.google.protobuf.CodedInputStream input)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseFrom(InputStream input)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseFrom(ByteBuffer data)
static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock>	parser()
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

BLOB_ASSET_ID_FIELD_NUMBER

public static final int BLOB_ASSET_ID_FIELD_NUMBER

See Also:

• Constant Field Values

GCS_URI_FIELD_NUMBER

public static final int GCS_URI_FIELD_NUMBER

See Also:

• Constant Field Values

DATA_URI_FIELD_NUMBER

public static final int DATA_URI_FIELD_NUMBER

See Also:

• Constant Field Values

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER

See Also:

• Constant Field Values

IMAGE_TEXT_FIELD_NUMBER

public static final int IMAGE_TEXT_FIELD_NUMBER

See Also:

• Constant Field Values

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getImageSourceCase

public Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.ImageSourceCase getImageSourceCase()

Specified by:

getImageSourceCase in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

hasBlobAssetId

public boolean hasBlobAssetId()

 Optional. Asset id of the inline image. If set, find the image
 content in the blob_assets field.
 

string blob_asset_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasBlobAssetId in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

Whether the blobAssetId field is set.

getBlobAssetId

public String getBlobAssetId()

 Optional. Asset id of the inline image. If set, find the image
 content in the blob_assets field.
 

string blob_asset_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getBlobAssetId in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

The blobAssetId.

getBlobAssetIdBytes

public com.google.protobuf.ByteString getBlobAssetIdBytes()

 Optional. Asset id of the inline image. If set, find the image
 content in the blob_assets field.
 

string blob_asset_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getBlobAssetIdBytes in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

The bytes for blobAssetId.

hasGcsUri

public boolean hasGcsUri()

 Optional. Google Cloud Storage uri of the image.
 

string gcs_uri = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasGcsUri in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

Whether the gcsUri field is set.

getGcsUri

public String getGcsUri()

 Optional. Google Cloud Storage uri of the image.
 

string gcs_uri = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGcsUri in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

The gcsUri.

getGcsUriBytes

public com.google.protobuf.ByteString getGcsUriBytes()

 Optional. Google Cloud Storage uri of the image.
 

string gcs_uri = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGcsUriBytes in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

The bytes for gcsUri.

hasDataUri

public boolean hasDataUri()

 Optional. Data uri of the image.
 It is composed of four parts: a prefix (data:), a MIME type
 indicating the type of data, an optional base64 token if
 non-textual, and the data itself:
 data:[<mediatype>][;base64],<data>
 

string data_uri = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasDataUri in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

Whether the dataUri field is set.

getDataUri

public String getDataUri()

 Optional. Data uri of the image.
 It is composed of four parts: a prefix (data:), a MIME type
 indicating the type of data, an optional base64 token if
 non-textual, and the data itself:
 data:[<mediatype>][;base64],<data>
 

string data_uri = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDataUri in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

The dataUri.

getDataUriBytes

public com.google.protobuf.ByteString getDataUriBytes()

 Optional. Data uri of the image.
 It is composed of four parts: a prefix (data:), a MIME type
 indicating the type of data, an optional base64 token if
 non-textual, and the data itself:
 data:[<mediatype>][;base64],<data>
 

string data_uri = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDataUriBytes in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

The bytes for dataUri.

getMimeType

public String getMimeType()

 Mime type of the image. An IANA published [media type (MIME type)]
 (https://www.iana.org/assignments/media-types/media-types.xhtml).
 

string mime_type = 1;

Specified by:

getMimeType in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

The mimeType.

getMimeTypeBytes

public com.google.protobuf.ByteString getMimeTypeBytes()

 Mime type of the image. An IANA published [media type (MIME type)]
 (https://www.iana.org/assignments/media-types/media-types.xhtml).
 

string mime_type = 1;

Specified by:

getMimeTypeBytes in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

The bytes for mimeType.

getImageText

public String getImageText()

 Text extracted from the image using OCR or alt text describing the
 image.
 

string image_text = 2;

Specified by:

getImageText in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

The imageText.

getImageTextBytes

public com.google.protobuf.ByteString getImageTextBytes()

 Text extracted from the image using OCR or alt text describing the
 image.
 

string image_text = 2;

Specified by:

getImageTextBytes in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

The bytes for imageText.

hasAnnotations

public boolean hasAnnotations()

 Annotation of the image block.
 

.google.cloud.documentai.v1.Document.Annotations annotations = 3;

Specified by:

hasAnnotations in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

Whether the annotations field is set.

getAnnotations

public Document.Annotations getAnnotations()

 Annotation of the image block.
 

.google.cloud.documentai.v1.Document.Annotations annotations = 3;

Specified by:

getAnnotations in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Returns:

The annotations.

getAnnotationsOrBuilder

public Document.AnnotationsOrBuilder getAnnotationsOrBuilder()

 Annotation of the image block.
 

.google.cloud.documentai.v1.Document.Annotations annotations = 3;

Specified by:

getAnnotationsOrBuilder in interface Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(ByteBuffer data)
                                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(com.google.protobuf.ByteString data)
                                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock 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.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(byte[] data)
                                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(InputStream input)
                                                                              throws IOException

Throws:

IOException

parseFrom

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseDelimitedFrom(InputStream input)
                                                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                       throws IOException

Throws:

IOException

parseFrom

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(com.google.protobuf.CodedInputStream input)
                                                                              throws IOException

Throws:

IOException

parseFrom

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                              throws IOException

Throws:

IOException

newBuilderForType

public Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder newBuilder()

newBuilder

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder newBuilder(Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock prototype)

toBuilder

public Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock> 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.GeneratedMessage

getDefaultInstanceForType

public Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder