Class AnnotatedDataset (0.135.0)
0.207.0 (latest)
0.205.0
0.203.0
0.202.0
0.201.0
0.200.0
0.198.0
0.196.0
0.195.0
0.194.0
0.193.0
0.192.0
0.190.0
0.188.0
0.187.0
0.184.0
0.183.0
0.182.0
0.180.0
0.179.0
0.178.0
0.177.0
0.176.0
0.175.0
0.174.0
0.173.0
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 AnnotatedDataset extends GeneratedMessageV3 implements AnnotatedDatasetOrBuilder
AnnotatedDataset is a set holding annotations for data in a Dataset. Each
labeling task will generate an AnnotatedDataset under the Dataset that the
task is requested for.
Protobuf type google.cloud.datalabeling.v1beta1.AnnotatedDataset
Static Fields
ANNOTATION_SOURCE_FIELD_NUMBER
public static final int ANNOTATION_SOURCE_FIELD_NUMBER
Field Value
Type Description
int
ANNOTATION_TYPE_FIELD_NUMBER
public static final int ANNOTATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int
BLOCKING_RESOURCES_FIELD_NUMBER
public static final int BLOCKING_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int
COMPLETED_EXAMPLE_COUNT_FIELD_NUMBER
public static final int COMPLETED_EXAMPLE_COUNT_FIELD_NUMBER
Field Value
Type Description
int
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
EXAMPLE_COUNT_FIELD_NUMBER
public static final int EXAMPLE_COUNT_FIELD_NUMBER
Field Value
Type Description
int
LABEL_STATS_FIELD_NUMBER
public static final int LABEL_STATS_FIELD_NUMBER
Field Value
Type Description
int
public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static AnnotatedDataset getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static AnnotatedDataset . Builder newBuilder ()
newBuilder(AnnotatedDataset prototype)
public static AnnotatedDataset . Builder newBuilder ( AnnotatedDataset prototype )
public static AnnotatedDataset parseDelimitedFrom ( InputStream input )
public static AnnotatedDataset parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static AnnotatedDataset parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AnnotatedDataset parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static AnnotatedDataset parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnnotatedDataset parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static AnnotatedDataset parseFrom ( CodedInputStream input )
public static AnnotatedDataset parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static AnnotatedDataset parseFrom ( InputStream input )
public static AnnotatedDataset parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static AnnotatedDataset parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AnnotatedDataset parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<AnnotatedDataset> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getAnnotationSource()
public AnnotationSource getAnnotationSource ()
Output only. Source of the annotation.
.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 3;
getAnnotationSourceValue()
public int getAnnotationSourceValue ()
Output only. Source of the annotation.
.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 3;
Returns
Type Description
int The enum numeric value on the wire for annotationSource.
getAnnotationType()
public AnnotationType getAnnotationType ()
Output only. Type of the annotation. It is specified when starting labeling
task.
.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 8;
getAnnotationTypeValue()
public int getAnnotationTypeValue ()
Output only. Type of the annotation. It is specified when starting labeling
task.
.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 8;
Returns
Type Description
int The enum numeric value on the wire for annotationType.
getBlockingResources(int index)
public String getBlockingResources ( int index )
Output only. The names of any related resources that are blocking changes
to the annotated dataset.
repeated string blocking_resources = 11;
Parameter
Name Description
indexint The index of the element to return.
Returns
Type Description
String The blockingResources at the given index.
getBlockingResourcesBytes(int index)
public ByteString getBlockingResourcesBytes ( int index )
Output only. The names of any related resources that are blocking changes
to the annotated dataset.
repeated string blocking_resources = 11;
Parameter
Name Description
indexint The index of the value to return.
Returns
Type Description
ByteString The bytes of the blockingResources at the given index.
getBlockingResourcesCount()
public int getBlockingResourcesCount ()
Output only. The names of any related resources that are blocking changes
to the annotated dataset.
repeated string blocking_resources = 11;
Returns
Type Description
int The count of blockingResources.
getBlockingResourcesList()
public ProtocolStringList getBlockingResourcesList ()
Output only. The names of any related resources that are blocking changes
to the annotated dataset.
repeated string blocking_resources = 11;
getCompletedExampleCount()
public long getCompletedExampleCount ()
Output only. Number of examples that have annotation in the annotated
dataset.
int64 completed_example_count = 5;
Returns
Type Description
long The completedExampleCount.
getCreateTime()
public Timestamp getCreateTime ()
Output only. Time the AnnotatedDataset was created.
.google.protobuf.Timestamp create_time = 7;
Returns
Type Description
Timestamp The createTime.
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder ()
Output only. Time the AnnotatedDataset was created.
.google.protobuf.Timestamp create_time = 7;
getDefaultInstanceForType()
public AnnotatedDataset getDefaultInstanceForType ()
getDescription()
public String getDescription ()
Output only. The description of the AnnotatedDataset. It is specified in
HumanAnnotationConfig when user starts a labeling task. Maximum of 10000
characters.
string description = 9;
Returns
Type Description
String The description.
getDescriptionBytes()
public ByteString getDescriptionBytes ()
Output only. The description of the AnnotatedDataset. It is specified in
HumanAnnotationConfig when user starts a labeling task. Maximum of 10000
characters.
string description = 9;
Returns
Type Description
ByteString The bytes for description.
getDisplayName()
public String getDisplayName ()
Output only. The display name of the AnnotatedDataset. It is specified in
HumanAnnotationConfig when user starts a labeling task. Maximum of 64
characters.
string display_name = 2;
Returns
Type Description
String The displayName.
getDisplayNameBytes()
public ByteString getDisplayNameBytes ()
Output only. The display name of the AnnotatedDataset. It is specified in
HumanAnnotationConfig when user starts a labeling task. Maximum of 64
characters.
string display_name = 2;
Returns
Type Description
ByteString The bytes for displayName.
getExampleCount()
public long getExampleCount ()
Output only. Number of examples in the annotated dataset.
int64 example_count = 4;
Returns
Type Description
long The exampleCount.
getLabelStats()
public LabelStats getLabelStats ()
Output only. Per label statistics.
.google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;
Returns
Type Description
LabelStats The labelStats.
getLabelStatsOrBuilder()
public LabelStatsOrBuilder getLabelStatsOrBuilder ()
Output only. Per label statistics.
.google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;
public AnnotatedDatasetMetadata getMetadata ()
Output only. Additional information about AnnotatedDataset.
.google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata metadata = 10;
public AnnotatedDatasetMetadataOrBuilder getMetadataOrBuilder ()
Output only. Additional information about AnnotatedDataset.
.google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata metadata = 10;
getName()
Output only. AnnotatedDataset resource name in format of:
projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
{annotated_dataset_id}
string name = 1;
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Output only. AnnotatedDataset resource name in format of:
projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
{annotated_dataset_id}
string name = 1;
Returns
Type Description
ByteString The bytes for name.
getParserForType()
public Parser<AnnotatedDataset> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
hasCreateTime()
public boolean hasCreateTime ()
Output only. Time the AnnotatedDataset was created.
.google.protobuf.Timestamp create_time = 7;
Returns
Type Description
boolean Whether the createTime field is set.
hasLabelStats()
public boolean hasLabelStats ()
Output only. Per label statistics.
.google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;
Returns
Type Description
boolean Whether the labelStats field is set.
public boolean hasMetadata ()
Output only. Additional information about AnnotatedDataset.
.google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata metadata = 10;
Returns
Type Description
boolean Whether the metadata field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public AnnotatedDataset . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AnnotatedDataset . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public AnnotatedDataset . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
