Class Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock (2.87.0)

Version latest

• 2.87.0 (latest)
• 2.86.0
• 2.85.0
• 2.84.0
• 2.82.0
• 2.80.0
• 2.79.0
• 2.78.0
• 2.77.0
• 2.76.0
• 2.74.0
• 2.72.0
• 2.71.0
• 2.68.0
• 2.67.0
• 2.66.0
• 2.64.0
• 2.63.0
• 2.62.0
• 2.61.0
• 2.60.0
• 2.59.0
• 2.58.0
• 2.57.0
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

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

Represents an image type block.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Implements

Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlockOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER

Field Value
Type	Description
int

BLOB_ASSET_ID_FIELD_NUMBER

public static final int BLOB_ASSET_ID_FIELD_NUMBER

Field Value
Type	Description
int

DATA_URI_FIELD_NUMBER

public static final int DATA_URI_FIELD_NUMBER

Field Value
Type	Description
int

GCS_URI_FIELD_NUMBER

public static final int GCS_URI_FIELD_NUMBER

Field Value
Type	Description
int

IMAGE_TEXT_FIELD_NUMBER

public static final int IMAGE_TEXT_FIELD_NUMBER

Field Value
Type	Description
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

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

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

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

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder

newBuilder(Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock prototype)

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

Parameter
Name	Description
prototype	Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder

parseDelimitedFrom(InputStream input)

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

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

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

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

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

Returns
Type	Description
Parser<LayoutImageBlock>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAnnotations()

public Document.Annotations getAnnotations()

Annotation of the image block.

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

Returns
Type	Description
Document.Annotations	The annotations.

getAnnotationsOrBuilder()

public Document.AnnotationsOrBuilder getAnnotationsOrBuilder()

Annotation of the image block.

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

Returns
Type	Description
Document.AnnotationsOrBuilder

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

Returns
Type	Description
String	The blobAssetId.

getBlobAssetIdBytes()

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

Returns
Type	Description
ByteString	The bytes for blobAssetId.

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>,<data>.

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

Returns
Type	Description
String	The dataUri.

getDataUriBytes()

public 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>,<data>.

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

Returns
Type	Description
ByteString	The bytes for dataUri.

getDefaultInstanceForType()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock getDefaultInstanceForType()

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

getGcsUri()

public String getGcsUri()

Optional. Google Cloud Storage URI of the image.

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

Returns
Type	Description
String	The gcsUri.

getGcsUriBytes()

public ByteString getGcsUriBytes()

Optional. Google Cloud Storage URI of the image.

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

Returns
Type	Description
ByteString	The bytes for gcsUri.

getImageSourceCase()

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

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.ImageSourceCase

getImageText()

public String getImageText()

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

string image_text = 2;

Returns
Type	Description
String	The imageText.

getImageTextBytes()

public ByteString getImageTextBytes()

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

string image_text = 2;

Returns
Type	Description
ByteString	The bytes for imageText.

getMimeType()

public String getMimeType()

Mime type of the image. An IANA published media type (MIME type).

string mime_type = 1;

Returns
Type	Description
String	The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

Mime type of the image. An IANA published media type (MIME type).

string mime_type = 1;

Returns
Type	Description
ByteString	The bytes for mimeType.

getParserForType()

public Parser<Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock> getParserForType()

Returns
Type	Description
Parser<LayoutImageBlock>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hasAnnotations()

public boolean hasAnnotations()

Annotation of the image block.

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

Returns
Type	Description
boolean	Whether the annotations field is set.

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

Returns
Type	Description
boolean	Whether the blobAssetId field is set.

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>,<data>.

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

Returns
Type	Description
boolean	Whether the dataUri field is set.

hasGcsUri()

public boolean hasGcsUri()

Optional. Google Cloud Storage URI of the image.

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

Returns
Type	Description
boolean	Whether the gcsUri field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

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

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

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

Returns
Type	Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException