Class AnnotationPayload (2.27.0)

public final class AnnotationPayload extends GeneratedMessageV3 implements AnnotationPayloadOrBuilder

Contains annotation information that is relevant to AutoML.

Protobuf type google.cloud.automl.v1.AnnotationPayload

Static Fields

ANNOTATION_SPEC_ID_FIELD_NUMBER

public static final int ANNOTATION_SPEC_ID_FIELD_NUMBER
Field Value
TypeDescription
int

CLASSIFICATION_FIELD_NUMBER

public static final int CLASSIFICATION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_OBJECT_DETECTION_FIELD_NUMBER

public static final int IMAGE_OBJECT_DETECTION_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_EXTRACTION_FIELD_NUMBER

public static final int TEXT_EXTRACTION_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_SENTIMENT_FIELD_NUMBER

public static final int TEXT_SENTIMENT_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSLATION_FIELD_NUMBER

public static final int TRANSLATION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AnnotationPayload getDefaultInstance()
Returns
TypeDescription
AnnotationPayload

getDescriptor()

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

newBuilder()

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

newBuilder(AnnotationPayload prototype)

public static AnnotationPayload.Builder newBuilder(AnnotationPayload prototype)
Parameter
NameDescription
prototypeAnnotationPayload
Returns
TypeDescription
AnnotationPayload.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

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

The bytes for annotationSpecId.

getClassification()

public ClassificationAnnotation getClassification()

Annotation details for content or image classification.

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

Returns
TypeDescription
ClassificationAnnotation

The classification.

getClassificationOrBuilder()

public ClassificationAnnotationOrBuilder getClassificationOrBuilder()

Annotation details for content or image classification.

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

Returns
TypeDescription
ClassificationAnnotationOrBuilder

getDefaultInstanceForType()

public AnnotationPayload getDefaultInstanceForType()
Returns
TypeDescription
AnnotationPayload

getDetailCase()

public AnnotationPayload.DetailCase getDetailCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for displayName.

getImageObjectDetection()

public ImageObjectDetectionAnnotation getImageObjectDetection()

Annotation details for image object detection.

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

Returns
TypeDescription
ImageObjectDetectionAnnotation

The imageObjectDetection.

getImageObjectDetectionOrBuilder()

public ImageObjectDetectionAnnotationOrBuilder getImageObjectDetectionOrBuilder()

Annotation details for image object detection.

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

Returns
TypeDescription
ImageObjectDetectionAnnotationOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTextExtraction()

public TextExtractionAnnotation getTextExtraction()

Annotation details for text extraction.

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

Returns
TypeDescription
TextExtractionAnnotation

The textExtraction.

getTextExtractionOrBuilder()

public TextExtractionAnnotationOrBuilder getTextExtractionOrBuilder()

Annotation details for text extraction.

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

Returns
TypeDescription
TextExtractionAnnotationOrBuilder

getTextSentiment()

public TextSentimentAnnotation getTextSentiment()

Annotation details for text sentiment.

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

Returns
TypeDescription
TextSentimentAnnotation

The textSentiment.

getTextSentimentOrBuilder()

public TextSentimentAnnotationOrBuilder getTextSentimentOrBuilder()

Annotation details for text sentiment.

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

Returns
TypeDescription
TextSentimentAnnotationOrBuilder

getTranslation()

public TranslationAnnotation getTranslation()

Annotation details for translation.

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

Returns
TypeDescription
TranslationAnnotation

The translation.

getTranslationOrBuilder()

public TranslationAnnotationOrBuilder getTranslationOrBuilder()

Annotation details for translation.

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

Returns
TypeDescription
TranslationAnnotationOrBuilder

hasClassification()

public boolean hasClassification()

Annotation details for content or image classification.

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

Returns
TypeDescription
boolean

Whether the classification field is set.

hasImageObjectDetection()

public boolean hasImageObjectDetection()

Annotation details for image object detection.

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

Returns
TypeDescription
boolean

Whether the imageObjectDetection field is set.

hasTextExtraction()

public boolean hasTextExtraction()

Annotation details for text extraction.

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

Returns
TypeDescription
boolean

Whether the textExtraction field is set.

hasTextSentiment()

public boolean hasTextSentiment()

Annotation details for text sentiment.

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

Returns
TypeDescription
boolean

Whether the textSentiment field is set.

hasTranslation()

public boolean hasTranslation()

Annotation details for translation.

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

Returns
TypeDescription
boolean

Whether the translation field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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