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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Example.Builder newBuilder()
newBuilder(Example prototype)
public static Example.Builder newBuilder(Example prototype)
| Parameter |
|---|
| Name | Description |
prototype | Example
|
public static Example parseDelimitedFrom(InputStream input)
public static Example parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Example parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Example parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Example parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Example parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Example parseFrom(CodedInputStream input)
public static Example parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Example parseFrom(InputStream input)
public static Example parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Example parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Example parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Example> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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
|
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;
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
|
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()
getImagePayload()
public ImagePayload getImagePayload()
The image payload, a container of the image bytes/uri.
.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;
getImagePayloadOrBuilder()
public ImagePayloadOrBuilder getImagePayloadOrBuilder()
The image payload, a container of the image bytes/uri.
.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;
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()
Overrides
getPayloadCase()
public Example.PayloadCase getPayloadCase()
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;
getTextPayloadOrBuilder()
public TextPayloadOrBuilder getTextPayloadOrBuilder()
The text payload, a container of the text content.
.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;
getVideoPayload()
public VideoPayload getVideoPayload()
The video payload, a container of the video uri.
.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;
getVideoPayloadOrBuilder()
public VideoPayloadOrBuilder getVideoPayloadOrBuilder()
The video payload, a container of the video uri.
.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;
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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Example.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Example.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Example.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
