Class Document.Page.Image (2.23.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.v1beta3.Document.Page.Image

Static Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
TypeDescription
int

HEIGHT_FIELD_NUMBER

public static final int HEIGHT_FIELD_NUMBER
Field Value
TypeDescription
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

WIDTH_FIELD_NUMBER

public static final int WIDTH_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Document.Page.Image getDefaultInstance()
Returns
TypeDescription
Document.Page.Image

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Document.Page.Image.Builder newBuilder()
Returns
TypeDescription
Document.Page.Image.Builder

newBuilder(Document.Page.Image prototype)

public static Document.Page.Image.Builder newBuilder(Document.Page.Image prototype)
Parameter
NameDescription
prototypeDocument.Page.Image
Returns
TypeDescription
Document.Page.Image.Builder

parseDelimitedFrom(InputStream input)

public static Document.Page.Image parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Document.Page.Image parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Page.Image parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Page.Image parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Document.Page.Image parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Document.Page.Image parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Image parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getContent()

public ByteString getContent()

Raw byte content of the image.

bytes content = 1;

Returns
TypeDescription
ByteString

The content.

getDefaultInstanceForType()

public Document.Page.Image getDefaultInstanceForType()
Returns
TypeDescription
Document.Page.Image

getHeight()

public int getHeight()

Height of the image in pixels.

int32 height = 4;

Returns
TypeDescription
int

The height.

getMimeType()

public String getMimeType()

Encoding mime type for the image.

string mime_type = 2;

Returns
TypeDescription
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

Encoding mime type for the image.

string mime_type = 2;

Returns
TypeDescription
ByteString

The bytes for mimeType.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getWidth()

public int getWidth()

Width of the image in pixels.

int32 width = 3;

Returns
TypeDescription
int

The width.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Document.Page.Image.Builder newBuilderForType()
Returns
TypeDescription
Document.Page.Image.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Page.Image.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Document.Page.Image.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Document.Page.Image.Builder toBuilder()
Returns
TypeDescription
Document.Page.Image.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException