Class Example (0.125.0)

Version 0.125.0

• 0.173.0 (latest)
• 0.172.0
• 0.171.0
• 0.169.0
• 0.168.0
• 0.167.0
• 0.166.0
• 0.165.0
• 0.164.0
• 0.163.0
• 0.162.0
• 0.161.0
• 0.160.0
• 0.159.0
• 0.157.0
• 0.156.0
• 0.155.0
• 0.154.0
• 0.153.0
• 0.152.0
• 0.151.0
• 0.150.0
• 0.149.0
• 0.148.0
• 0.147.0
• 0.144.0
• 0.143.0
• 0.142.0
• 0.141.0
• 0.140.0
• 0.139.0
• 0.138.0
• 0.137.0
• 0.136.0
• 0.135.0
• 0.134.0
• 0.133.0
• 0.132.0
• 0.131.0
• 0.129.0
• 0.128.0
• 0.127.0
• 0.126.0
• 0.125.0
• 0.124.0
• 0.123.7
• 0.122.11

public final class Example extends GeneratedMessageV3 implements ExampleOrBuilder

An Example is a piece of data and its annotation. For example, an image with label "house".

Protobuf type google.cloud.datalabeling.v1beta1.Example

Inheritance

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

Implements

ExampleOrBuilder

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

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER

Field Value

Type	Description
int

IMAGE_PAYLOAD_FIELD_NUMBER

public static final int IMAGE_PAYLOAD_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

TEXT_PAYLOAD_FIELD_NUMBER

public static final int TEXT_PAYLOAD_FIELD_NUMBER

Field Value

Type	Description
int

VIDEO_PAYLOAD_FIELD_NUMBER

public static final int VIDEO_PAYLOAD_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static Example getDefaultInstance()

Returns

Type	Description
Example

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Example.Builder newBuilder()

Returns

Type	Description
Example.Builder

newBuilder(Example prototype)

public static Example.Builder newBuilder(Example prototype)

Parameter

Name	Description
prototype	Example

Returns

Type	Description
Example.Builder

parseDelimitedFrom(InputStream input)

public static Example parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Example

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Example parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Example

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Example parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Example

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Example

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Example parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Example

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Example parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Example

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Example parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Example

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Example parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Example

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Example parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Example

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Example parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Example

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Example parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Example

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Example parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Example

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Example> parser()

Returns

Type	Description
Parser<Example>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAnnotations(int index)

public Annotation getAnnotations(int index)

Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameter

Name	Description
index	int

Returns

Type	Description
Annotation

getAnnotationsCount()

public int getAnnotationsCount()

Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Returns

Type	Description
int

getAnnotationsList()

public List<Annotation> getAnnotationsList()

Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Returns

Type	Description
List<Annotation>

getAnnotationsOrBuilder(int index)

public AnnotationOrBuilder getAnnotationsOrBuilder(int index)

Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameter

Name	Description
index	int

Returns

Type	Description
AnnotationOrBuilder

getAnnotationsOrBuilderList()

public List<? extends AnnotationOrBuilder> getAnnotationsOrBuilderList()

Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Returns

Type	Description
List<? extends com.google.cloud.datalabeling.v1beta1.AnnotationOrBuilder>

getDefaultInstanceForType()

public Example getDefaultInstanceForType()

Returns

Type	Description
Example

getImagePayload()

public ImagePayload getImagePayload()

The image payload, a container of the image bytes/uri.

.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;

Returns

Type	Description
ImagePayload	The imagePayload.

getImagePayloadOrBuilder()

public ImagePayloadOrBuilder getImagePayloadOrBuilder()

The image payload, a container of the image bytes/uri.

.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;

Returns

Type	Description
ImagePayloadOrBuilder

getName()

public String getName()

Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<Example> getParserForType()

Returns

Type	Description
Parser<Example>

Overrides

GeneratedMessageV3.getParserForType()

getPayloadCase()

public Example.PayloadCase getPayloadCase()

Returns

Type	Description
Example.PayloadCase

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTextPayload()

public TextPayload getTextPayload()

The text payload, a container of the text content.

.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;

Returns

Type	Description
TextPayload	The textPayload.

getTextPayloadOrBuilder()

public TextPayloadOrBuilder getTextPayloadOrBuilder()

The text payload, a container of the text content.

.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;

Returns

Type	Description
TextPayloadOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getVideoPayload()

public VideoPayload getVideoPayload()

The video payload, a container of the video uri.

.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;

Returns

Type	Description
VideoPayload	The videoPayload.

getVideoPayloadOrBuilder()

public VideoPayloadOrBuilder getVideoPayloadOrBuilder()

The video payload, a container of the video uri.

.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;

Returns

Type	Description
VideoPayloadOrBuilder

hasImagePayload()

public boolean hasImagePayload()

The image payload, a container of the image bytes/uri.

.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;

Returns

Type	Description
boolean	Whether the imagePayload field is set.

hasTextPayload()

public boolean hasTextPayload()

The text payload, a container of the text content.

.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;

Returns

Type	Description
boolean	Whether the textPayload field is set.

hasVideoPayload()

public boolean hasVideoPayload()

The video payload, a container of the video uri.

.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;

Returns

Type	Description
boolean	Whether the videoPayload 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 Example.Builder newBuilderForType()

Returns

Type	Description
Example.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Example.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Example.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 Example.Builder toBuilder()

Returns

Type	Description
Example.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException