Class AnnotationPayload (2.16.0)

Version 2.16.0

• 2.51.0 (latest)
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.18
• 2.2.3
• 2.1.23

public final class AnnotationPayload extends GeneratedMessageV3 implements AnnotationPayloadOrBuilder

Contains annotation information that is relevant to AutoML.

Protobuf type google.cloud.automl.v1beta1.AnnotationPayload

Inheritance

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

Implements

AnnotationPayloadOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ANNOTATION_SPEC_ID_FIELD_NUMBER

public static final int ANNOTATION_SPEC_ID_FIELD_NUMBER

Field Value
Type	Description
int

CLASSIFICATION_FIELD_NUMBER

public static final int CLASSIFICATION_FIELD_NUMBER

Field Value
Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

IMAGE_OBJECT_DETECTION_FIELD_NUMBER

public static final int IMAGE_OBJECT_DETECTION_FIELD_NUMBER

Field Value
Type	Description
int

TABLES_FIELD_NUMBER

public static final int TABLES_FIELD_NUMBER

Field Value
Type	Description
int

TEXT_EXTRACTION_FIELD_NUMBER

public static final int TEXT_EXTRACTION_FIELD_NUMBER

Field Value
Type	Description
int

TEXT_SENTIMENT_FIELD_NUMBER

public static final int TEXT_SENTIMENT_FIELD_NUMBER

Field Value
Type	Description
int

TRANSLATION_FIELD_NUMBER

public static final int TRANSLATION_FIELD_NUMBER

Field Value
Type	Description
int

VIDEO_CLASSIFICATION_FIELD_NUMBER

public static final int VIDEO_CLASSIFICATION_FIELD_NUMBER

Field Value
Type	Description
int

VIDEO_OBJECT_TRACKING_FIELD_NUMBER

public static final int VIDEO_OBJECT_TRACKING_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static AnnotationPayload getDefaultInstance()

Returns
Type	Description
AnnotationPayload

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static AnnotationPayload.Builder newBuilder()

Returns
Type	Description
AnnotationPayload.Builder

newBuilder(AnnotationPayload prototype)

public static AnnotationPayload.Builder newBuilder(AnnotationPayload prototype)

Parameter
Name	Description
prototype	AnnotationPayload

Returns
Type	Description
AnnotationPayload.Builder

parseDelimitedFrom(InputStream input)

public static AnnotationPayload parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotationPayload parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static AnnotationPayload parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotationPayload parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotationPayload parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotationPayload parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotationPayload parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotationPayload parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static AnnotationPayload parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotationPayload parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static AnnotationPayload parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotationPayload parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AnnotationPayload

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<AnnotationPayload> parser()

Returns
Type	Description
Parser<AnnotationPayload>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAnnotationSpecId()

public String getAnnotationSpecId()

Output only . The resource ID of the annotation spec that this annotation pertains to. The annotation spec comes from either an ancestor dataset, or the dataset that was used to train the model in use.

string annotation_spec_id = 1;

Returns
Type	Description
String	The annotationSpecId.

getAnnotationSpecIdBytes()

public ByteString getAnnotationSpecIdBytes()

Output only . The resource ID of the annotation spec that this annotation pertains to. The annotation spec comes from either an ancestor dataset, or the dataset that was used to train the model in use.

string annotation_spec_id = 1;

Returns
Type	Description
ByteString	The bytes for annotationSpecId.

getClassification()

public ClassificationProto.ClassificationAnnotation getClassification()

Annotation details for content or image classification.

.google.cloud.automl.v1beta1.ClassificationAnnotation classification = 3;

Returns
Type	Description
ClassificationProto.ClassificationAnnotation	The classification.

getClassificationOrBuilder()

public ClassificationProto.ClassificationAnnotationOrBuilder getClassificationOrBuilder()

Annotation details for content or image classification.

.google.cloud.automl.v1beta1.ClassificationAnnotation classification = 3;

Returns
Type	Description
ClassificationProto.ClassificationAnnotationOrBuilder

getDefaultInstanceForType()

public AnnotationPayload getDefaultInstanceForType()

Returns
Type	Description
AnnotationPayload

getDetailCase()

public AnnotationPayload.DetailCase getDetailCase()

Returns
Type	Description
AnnotationPayload.DetailCase

getDisplayName()

public String getDisplayName()

Output only. The value of display_name when the model was trained. Because this field returns a value at model training time, for different models trained using the same dataset, the returned value could be different as model owner could update the display_name between any two model training.

string display_name = 5;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. The value of display_name when the model was trained. Because this field returns a value at model training time, for different models trained using the same dataset, the returned value could be different as model owner could update the display_name between any two model training.

string display_name = 5;

Returns
Type	Description
ByteString	The bytes for displayName.

getImageObjectDetection()

public ImageObjectDetectionAnnotation getImageObjectDetection()

Annotation details for image object detection.

.google.cloud.automl.v1beta1.ImageObjectDetectionAnnotation image_object_detection = 4;

Returns
Type	Description
ImageObjectDetectionAnnotation	The imageObjectDetection.

getImageObjectDetectionOrBuilder()

public ImageObjectDetectionAnnotationOrBuilder getImageObjectDetectionOrBuilder()

Annotation details for image object detection.

.google.cloud.automl.v1beta1.ImageObjectDetectionAnnotation image_object_detection = 4;

Returns
Type	Description
ImageObjectDetectionAnnotationOrBuilder

getParserForType()

public Parser<AnnotationPayload> getParserForType()

Returns
Type	Description
Parser<AnnotationPayload>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTables()

public TablesAnnotation getTables()

Annotation details for Tables.

.google.cloud.automl.v1beta1.TablesAnnotation tables = 10;

Returns
Type	Description
TablesAnnotation	The tables.

getTablesOrBuilder()

public TablesAnnotationOrBuilder getTablesOrBuilder()

Annotation details for Tables.

.google.cloud.automl.v1beta1.TablesAnnotation tables = 10;

Returns
Type	Description
TablesAnnotationOrBuilder

getTextExtraction()

public TextExtractionAnnotation getTextExtraction()

Annotation details for text extraction.

.google.cloud.automl.v1beta1.TextExtractionAnnotation text_extraction = 6;

Returns
Type	Description
TextExtractionAnnotation	The textExtraction.

getTextExtractionOrBuilder()

public TextExtractionAnnotationOrBuilder getTextExtractionOrBuilder()

Annotation details for text extraction.

.google.cloud.automl.v1beta1.TextExtractionAnnotation text_extraction = 6;

Returns
Type	Description
TextExtractionAnnotationOrBuilder

getTextSentiment()

public TextSentimentProto.TextSentimentAnnotation getTextSentiment()

Annotation details for text sentiment.

.google.cloud.automl.v1beta1.TextSentimentAnnotation text_sentiment = 7;

Returns
Type	Description
TextSentimentProto.TextSentimentAnnotation	The textSentiment.

getTextSentimentOrBuilder()

public TextSentimentProto.TextSentimentAnnotationOrBuilder getTextSentimentOrBuilder()

Annotation details for text sentiment.

.google.cloud.automl.v1beta1.TextSentimentAnnotation text_sentiment = 7;

Returns
Type	Description
TextSentimentProto.TextSentimentAnnotationOrBuilder

getTranslation()

public TranslationAnnotation getTranslation()

Annotation details for translation.

.google.cloud.automl.v1beta1.TranslationAnnotation translation = 2;

Returns
Type	Description
TranslationAnnotation	The translation.

getTranslationOrBuilder()

public TranslationAnnotationOrBuilder getTranslationOrBuilder()

Annotation details for translation.

.google.cloud.automl.v1beta1.TranslationAnnotation translation = 2;

Returns
Type	Description
TranslationAnnotationOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getVideoClassification()

public ClassificationProto.VideoClassificationAnnotation getVideoClassification()

Annotation details for video classification. Returned for Video Classification predictions.

.google.cloud.automl.v1beta1.VideoClassificationAnnotation video_classification = 9;

Returns
Type	Description
ClassificationProto.VideoClassificationAnnotation	The videoClassification.

getVideoClassificationOrBuilder()

public ClassificationProto.VideoClassificationAnnotationOrBuilder getVideoClassificationOrBuilder()

Annotation details for video classification. Returned for Video Classification predictions.

.google.cloud.automl.v1beta1.VideoClassificationAnnotation video_classification = 9;

Returns
Type	Description
ClassificationProto.VideoClassificationAnnotationOrBuilder

getVideoObjectTracking()

public VideoObjectTrackingAnnotation getVideoObjectTracking()

Annotation details for video object tracking.

.google.cloud.automl.v1beta1.VideoObjectTrackingAnnotation video_object_tracking = 8;

Returns
Type	Description
VideoObjectTrackingAnnotation	The videoObjectTracking.

getVideoObjectTrackingOrBuilder()

public VideoObjectTrackingAnnotationOrBuilder getVideoObjectTrackingOrBuilder()

Annotation details for video object tracking.

.google.cloud.automl.v1beta1.VideoObjectTrackingAnnotation video_object_tracking = 8;

Returns
Type	Description
VideoObjectTrackingAnnotationOrBuilder

hasClassification()

public boolean hasClassification()

Annotation details for content or image classification.

.google.cloud.automl.v1beta1.ClassificationAnnotation classification = 3;

Returns
Type	Description
boolean	Whether the classification field is set.

hasImageObjectDetection()

public boolean hasImageObjectDetection()

Annotation details for image object detection.

.google.cloud.automl.v1beta1.ImageObjectDetectionAnnotation image_object_detection = 4;

Returns
Type	Description
boolean	Whether the imageObjectDetection field is set.

hasTables()

public boolean hasTables()

Annotation details for Tables.

.google.cloud.automl.v1beta1.TablesAnnotation tables = 10;

Returns
Type	Description
boolean	Whether the tables field is set.

hasTextExtraction()

public boolean hasTextExtraction()

Annotation details for text extraction.

.google.cloud.automl.v1beta1.TextExtractionAnnotation text_extraction = 6;

Returns
Type	Description
boolean	Whether the textExtraction field is set.

hasTextSentiment()

public boolean hasTextSentiment()

Annotation details for text sentiment.

.google.cloud.automl.v1beta1.TextSentimentAnnotation text_sentiment = 7;

Returns
Type	Description
boolean	Whether the textSentiment field is set.

hasTranslation()

public boolean hasTranslation()

Annotation details for translation.

.google.cloud.automl.v1beta1.TranslationAnnotation translation = 2;

Returns
Type	Description
boolean	Whether the translation field is set.

hasVideoClassification()

public boolean hasVideoClassification()

Annotation details for video classification. Returned for Video Classification predictions.

.google.cloud.automl.v1beta1.VideoClassificationAnnotation video_classification = 9;

Returns
Type	Description
boolean	Whether the videoClassification field is set.

hasVideoObjectTracking()

public boolean hasVideoObjectTracking()

Annotation details for video object tracking.

.google.cloud.automl.v1beta1.VideoObjectTrackingAnnotation video_object_tracking = 8;

Returns
Type	Description
boolean	Whether the videoObjectTracking field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public AnnotationPayload.Builder newBuilderForType()

Returns
Type	Description
AnnotationPayload.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotationPayload.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
AnnotationPayload.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public AnnotationPayload.Builder toBuilder()

Returns
Type	Description
AnnotationPayload.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException