Class AnnotatedDataset (0.168.0)

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

METADATA_FIELD_NUMBER

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()
Returns
Type Description
AnnotatedDataset

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AnnotatedDataset.Builder newBuilder()
Returns
Type Description
AnnotatedDataset.Builder

newBuilder(AnnotatedDataset prototype)

public static AnnotatedDataset.Builder newBuilder(AnnotatedDataset prototype)
Parameter
Name Description
prototype AnnotatedDataset
Returns
Type Description
AnnotatedDataset.Builder

parseDelimitedFrom(InputStream input)

public static AnnotatedDataset parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotatedDataset parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnnotatedDataset parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotatedDataset parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotatedDataset parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotatedDataset parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotatedDataset parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotatedDataset parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnnotatedDataset parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotatedDataset parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnnotatedDataset parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotatedDataset parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatedDataset
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnnotatedDataset> parser()
Returns
Type Description
Parser<AnnotatedDataset>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnnotationSource()

public AnnotationSource getAnnotationSource()

Output only. Source of the annotation.

.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 3;

Returns
Type Description
AnnotationSource

The annotationSource.

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;

Returns
Type Description
AnnotationType

The annotationType.

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
index int

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
index int

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;

Returns
Type Description
ProtocolStringList

A list containing the blockingResources.

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;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public AnnotatedDataset getDefaultInstanceForType()
Returns
Type Description
AnnotatedDataset

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;

Returns
Type Description
LabelStatsOrBuilder

getMetadata()

public AnnotatedDatasetMetadata getMetadata()

Output only. Additional information about AnnotatedDataset.

.google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata metadata = 10;

Returns
Type Description
AnnotatedDatasetMetadata

The metadata.

getMetadataOrBuilder()

public AnnotatedDatasetMetadataOrBuilder getMetadataOrBuilder()

Output only. Additional information about AnnotatedDataset.

.google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata metadata = 10;

Returns
Type Description
AnnotatedDatasetMetadataOrBuilder

getName()

public String 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()
Returns
Type Description
Parser<AnnotatedDataset>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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.

hasMetadata()

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()

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 AnnotatedDataset.Builder newBuilderForType()
Returns
Type Description
AnnotatedDataset.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotatedDataset.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnnotatedDataset.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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