Class Document.BlobAsset (2.66.0)

public static final class Document.BlobAsset extends GeneratedMessageV3 implements Document.BlobAssetOrBuilder

Represents a blob asset. It's used to store the content of the inline blob in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.

Protobuf type google.cloud.documentai.v1beta3.Document.BlobAsset

Static Fields

ASSET_ID_FIELD_NUMBER

public static final int ASSET_ID_FIELD_NUMBER
Field Value
Type Description
int

CONTENT_FIELD_NUMBER

public static final int CONTENT_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.BlobAsset getDefaultInstance()
Returns
Type Description
Document.BlobAsset

getDescriptor()

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

newBuilder()

public static Document.BlobAsset.Builder newBuilder()
Returns
Type Description
Document.BlobAsset.Builder

newBuilder(Document.BlobAsset prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAssetId()

public String getAssetId()

Optional. The id of the blob asset.

string asset_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The assetId.

getAssetIdBytes()

public ByteString getAssetIdBytes()

Optional. The id of the blob asset.

string asset_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for assetId.

getContent()

public ByteString getContent()

Optional. The content of the blob asset, e.g. image bytes.

bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The content.

getDefaultInstanceForType()

public Document.BlobAsset getDefaultInstanceForType()
Returns
Type Description
Document.BlobAsset

getMimeType()

public String getMimeType()

The mime type of the blob asset. An IANA published media type (MIME type).

string mime_type = 3;

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

The mime type of the blob asset. An IANA published media type (MIME type).

string mime_type = 3;

Returns
Type Description
ByteString

The bytes for mimeType.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

writeTo(CodedOutputStream output)

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