Class TextExtractionPredictionInstance (2.5.3)

public final class TextExtractionPredictionInstance extends GeneratedMessageV3 implements TextExtractionPredictionInstanceOrBuilder

Prediction input format for Text Extraction.

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

Inheritance

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

Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
TypeDescription
int

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
TypeDescription
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

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

getContent()

public String getContent()

The text snippet to make the predictions on.

string content = 1;

Returns
TypeDescription
String

The content.

getContentBytes()

public ByteString getContentBytes()

The text snippet to make the predictions on.

string content = 1;

Returns
TypeDescription
ByteString

The bytes for content.

getDefaultInstance()

public static TextExtractionPredictionInstance getDefaultInstance()
Returns
TypeDescription
TextExtractionPredictionInstance

getDefaultInstanceForType()

public TextExtractionPredictionInstance getDefaultInstanceForType()
Returns
TypeDescription
TextExtractionPredictionInstance

getDescriptor()

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

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for mimeType.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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

newBuilder()

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

newBuilder(TextExtractionPredictionInstance prototype)

public static TextExtractionPredictionInstance.Builder newBuilder(TextExtractionPredictionInstance prototype)
Parameter
NameDescription
prototypeTextExtractionPredictionInstance
Returns
TypeDescription
TextExtractionPredictionInstance.Builder

newBuilderForType()

public TextExtractionPredictionInstance.Builder newBuilderForType()
Returns
TypeDescription
TextExtractionPredictionInstance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

toBuilder()

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

writeTo(CodedOutputStream output)

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