Class Example (0.162.0)

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

Implements

ExampleOrBuilder

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

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

getPayloadCase()

public Example.PayloadCase getPayloadCase()
Returns
Type Description
Example.PayloadCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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