Class Document.Page.Image (2.51.0)

public static final class Document.Page.Image extends GeneratedMessageV3 implements Document.Page.ImageOrBuilder

Rendered image contents for this page.

Protobuf type google.cloud.documentai.v1.Document.Page.Image

Static Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
Type Description
int

HEIGHT_FIELD_NUMBER

public static final int HEIGHT_FIELD_NUMBER
Field Value
Type Description
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
Type Description
int

WIDTH_FIELD_NUMBER

public static final int WIDTH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Document.Page.Image getDefaultInstance()
Returns
Type Description
Document.Page.Image

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Document.Page.Image.Builder newBuilder()
Returns
Type Description
Document.Page.Image.Builder

newBuilder(Document.Page.Image prototype)

public static Document.Page.Image.Builder newBuilder(Document.Page.Image prototype)
Parameter
Name Description
prototype Document.Page.Image
Returns
Type Description
Document.Page.Image.Builder

parseDelimitedFrom(InputStream input)

public static Document.Page.Image parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Document.Page.Image parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Page.Image parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Page.Image parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Document.Page.Image parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Document.Page.Image parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.Image
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Document.Page.Image> parser()
Returns
Type Description
Parser<Image>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContent()

public ByteString getContent()

Raw byte content of the image.

bytes content = 1;

Returns
Type Description
ByteString

The content.

getDefaultInstanceForType()

public Document.Page.Image getDefaultInstanceForType()
Returns
Type Description
Document.Page.Image

getHeight()

public int getHeight()

Height of the image in pixels.

int32 height = 4;

Returns
Type Description
int

The height.

getMimeType()

public String getMimeType()

Encoding media type (MIME type) for the image.

string mime_type = 2;

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

Encoding media type (MIME type) for the image.

string mime_type = 2;

Returns
Type Description
ByteString

The bytes for mimeType.

getParserForType()

public Parser<Document.Page.Image> getParserForType()
Returns
Type Description
Parser<Image>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getWidth()

public int getWidth()

Width of the image in pixels.

int32 width = 3;

Returns
Type Description
int

The width.

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.Page.Image.Builder newBuilderForType()
Returns
Type Description
Document.Page.Image.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Page.Image.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.Page.Image.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.Page.Image.Builder toBuilder()
Returns
Type Description
Document.Page.Image.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException