Class Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock (2.66.0)

public static final class Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock extends GeneratedMessageV3 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 > GeneratedMessageV3 > Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock

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

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder newBuilderForType()
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

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
Exceptions
Type Description
IOException