Class RawDocument (2.31.0)

public final class RawDocument extends GeneratedMessageV3 implements RawDocumentOrBuilder

Payload message of raw document content (bytes).

Protobuf type google.cloud.documentai.v1beta3.RawDocument

Static Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RawDocument getDefaultInstance()
Returns
TypeDescription
RawDocument

getDescriptor()

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

newBuilder()

public static RawDocument.Builder newBuilder()
Returns
TypeDescription
RawDocument.Builder

newBuilder(RawDocument prototype)

public static RawDocument.Builder newBuilder(RawDocument prototype)
Parameter
NameDescription
prototypeRawDocument
Returns
TypeDescription
RawDocument.Builder

parseDelimitedFrom(InputStream input)

public static RawDocument parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RawDocument
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RawDocument parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RawDocument
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RawDocument parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RawDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static RawDocument parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RawDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RawDocument parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RawDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RawDocument parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RawDocument
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RawDocument parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RawDocument
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RawDocument parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RawDocument
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RawDocument parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RawDocument
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RawDocument parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RawDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RawDocument parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RawDocument
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RawDocument> parser()
Returns
TypeDescription
Parser<RawDocument>

Methods

equals(Object obj)

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

getContent()

public ByteString getContent()

Inline document content.

bytes content = 1;

Returns
TypeDescription
ByteString

The content.

getDefaultInstanceForType()

public RawDocument getDefaultInstanceForType()
Returns
TypeDescription
RawDocument

getDisplayName()

public String getDisplayName()

The display name of the document, it supports all Unicode characters except the following: *, ?, [, ], %, {, },', \", , ~, = and : are reserved. If not specified, a default ID is generated.

string display_name = 3;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the document, it supports all Unicode characters except the following: *, ?, [, ], %, {, },', \", , ~, = and : are reserved. If not specified, a default ID is generated.

string display_name = 3;

Returns
TypeDescription
ByteString

The bytes for displayName.

getMimeType()

public String getMimeType()

An IANA MIME type (RFC6838) indicating the nature and format of the content.

string mime_type = 2;

Returns
TypeDescription
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

An IANA MIME type (RFC6838) indicating the nature and format of the content.

string mime_type = 2;

Returns
TypeDescription
ByteString

The bytes for mimeType.

getParserForType()

public Parser<RawDocument> getParserForType()
Returns
TypeDescription
Parser<RawDocument>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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 RawDocument.Builder newBuilderForType()
Returns
TypeDescription
RawDocument.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RawDocument.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RawDocument.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public RawDocument.Builder toBuilder()
Returns
TypeDescription
RawDocument.Builder

writeTo(CodedOutputStream output)

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