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
ANNOTATION_TYPE_FIELD_NUMBER
public static final int ANNOTATION_TYPE_FIELD_NUMBER
Field Value
BLOCKING_RESOURCES_FIELD_NUMBER
public static final int BLOCKING_RESOURCES_FIELD_NUMBER
Field Value
COMPLETED_EXAMPLE_COUNT_FIELD_NUMBER
public static final int COMPLETED_EXAMPLE_COUNT_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
EXAMPLE_COUNT_FIELD_NUMBER
public static final int EXAMPLE_COUNT_FIELD_NUMBER
Field Value
LABEL_STATS_FIELD_NUMBER
public static final int LABEL_STATS_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AnnotatedDataset getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AnnotatedDataset.Builder newBuilder()
Returns
newBuilder(AnnotatedDataset prototype)
public static AnnotatedDataset.Builder newBuilder(AnnotatedDataset prototype)
Parameter
Returns
public static AnnotatedDataset parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AnnotatedDataset parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AnnotatedDataset parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AnnotatedDataset parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AnnotatedDataset parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnnotatedDataset parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AnnotatedDataset parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AnnotatedDataset parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AnnotatedDataset parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AnnotatedDataset parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AnnotatedDataset parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AnnotatedDataset parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AnnotatedDataset> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
| 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;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| long | The completedExampleCount.
|
getCreateTime()
public Timestamp getCreateTime()
Output only. Time the AnnotatedDataset was created.
.google.protobuf.Timestamp create_time = 7;
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time the AnnotatedDataset was created.
.google.protobuf.Timestamp create_time = 7;
getDefaultInstanceForType()
public AnnotatedDataset getDefaultInstanceForType()
Returns
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;
| 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;
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for displayName.
|
getExampleCount()
public long getExampleCount()
Output only. Number of examples in the annotated dataset.
int64 example_count = 4;
| Type | Description |
| long | The exampleCount.
|
getLabelStats()
public LabelStats getLabelStats()
Output only. Per label statistics.
.google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;
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;
| 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;
getParserForType()
public Parser<AnnotatedDataset> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasCreateTime()
public boolean hasCreateTime()
Output only. Time the AnnotatedDataset was created.
.google.protobuf.Timestamp create_time = 7;
| 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;
| 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;
| Type | Description |
| boolean | Whether the metadata field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AnnotatedDataset.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AnnotatedDataset.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AnnotatedDataset.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
