Class TextExtractionPredictionInstance (3.54.0)

public final class TextExtractionPredictionInstance extends GeneratedMessageV3 implements TextExtractionPredictionInstanceOrBuilder

Prediction input format for Text Extraction.

Protobuf type google.cloud.aiplatform.v1beta1.schema.predict.instance.TextExtractionPredictionInstance

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TextExtractionPredictionInstance

Static Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
Type Description
int

KEY_FIELD_NUMBER

public static final int KEY_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 TextExtractionPredictionInstance getDefaultInstance()
Returns
Type Description
TextExtractionPredictionInstance

getDescriptor()

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

newBuilder()

public static TextExtractionPredictionInstance.Builder newBuilder()
Returns
Type Description
TextExtractionPredictionInstance.Builder

newBuilder(TextExtractionPredictionInstance prototype)

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

parseDelimitedFrom(InputStream input)

public static TextExtractionPredictionInstance parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TextExtractionPredictionInstance
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static TextExtractionPredictionInstance parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TextExtractionPredictionInstance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static TextExtractionPredictionInstance parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TextExtractionPredictionInstance
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static TextExtractionPredictionInstance parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TextExtractionPredictionInstance
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static TextExtractionPredictionInstance parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TextExtractionPredictionInstance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<TextExtractionPredictionInstance> parser()
Returns
Type Description
Parser<TextExtractionPredictionInstance>

Methods

equals(Object obj)

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

getContent()

public String getContent()

The text snippet to make the predictions on.

string content = 1;

Returns
Type Description
String

The content.

getContentBytes()

public ByteString getContentBytes()

The text snippet to make the predictions on.

string content = 1;

Returns
Type Description
ByteString

The bytes for content.

getDefaultInstanceForType()

public TextExtractionPredictionInstance getDefaultInstanceForType()
Returns
Type Description
TextExtractionPredictionInstance

getKey()

public String getKey()

This field is only used for batch prediction. If a key is provided, the batch prediction result will by mapped to this key. If omitted, then the batch prediction result will contain the entire input instance. Vertex AI will not check if keys in the request are duplicates, so it is up to the caller to ensure the keys are unique.

string key = 3;

Returns
Type Description
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

This field is only used for batch prediction. If a key is provided, the batch prediction result will by mapped to this key. If omitted, then the batch prediction result will contain the entire input instance. Vertex AI will not check if keys in the request are duplicates, so it is up to the caller to ensure the keys are unique.

string key = 3;

Returns
Type Description
ByteString

The bytes for key.

getMimeType()

public String getMimeType()

The MIME type of the text snippet. The supported MIME types are listed below.

  • text/plain

string mime_type = 2;

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

The MIME type of the text snippet. The supported MIME types are listed below.

  • text/plain

string mime_type = 2;

Returns
Type Description
ByteString

The bytes for mimeType.

getParserForType()

public Parser<TextExtractionPredictionInstance> getParserForType()
Returns
Type Description
Parser<TextExtractionPredictionInstance>
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 TextExtractionPredictionInstance.Builder newBuilderForType()
Returns
Type Description
TextExtractionPredictionInstance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TextExtractionPredictionInstance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TextExtractionPredictionInstance.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public TextExtractionPredictionInstance.Builder toBuilder()
Returns
Type Description
TextExtractionPredictionInstance.Builder

writeTo(CodedOutputStream output)

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