com.google.cloud.datalabeling.v1beta1

Class AnnotatedDataset

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.datalabeling.v1beta1.AnnotatedDataset

All Implemented Interfaces:

AnnotatedDatasetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class AnnotatedDataset
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotatedDataset.Builder AnnotatedDataset is a set holding annotations for data in a Dataset.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANNOTATION_SOURCE_FIELD_NUMBER
static int	ANNOTATION_TYPE_FIELD_NUMBER
static int	BLOCKING_RESOURCES_FIELD_NUMBER
static int	COMPLETED_EXAMPLE_COUNT_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	EXAMPLE_COUNT_FIELD_NUMBER
static int	LABEL_STATS_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER
static int	NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AnnotationSource	getAnnotationSource() Output only.
int	getAnnotationSourceValue() Output only.
AnnotationType	getAnnotationType() Output only.
int	getAnnotationTypeValue() Output only.
String	getBlockingResources(int index) Output only.
com.google.protobuf.ByteString	getBlockingResourcesBytes(int index) Output only.
int	getBlockingResourcesCount() Output only.
com.google.protobuf.ProtocolStringList	getBlockingResourcesList() Output only.
long	getCompletedExampleCount() Output only.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
static AnnotatedDataset	getDefaultInstance()
AnnotatedDataset	getDefaultInstanceForType()
String	getDescription() Output only.
com.google.protobuf.ByteString	getDescriptionBytes() Output only.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Output only.
com.google.protobuf.ByteString	getDisplayNameBytes() Output only.
long	getExampleCount() Output only.
LabelStats	getLabelStats() Output only.
LabelStatsOrBuilder	getLabelStatsOrBuilder() Output only.
AnnotatedDatasetMetadata	getMetadata() Output only.
AnnotatedDatasetMetadataOrBuilder	getMetadataOrBuilder() Output only.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
com.google.protobuf.Parser<AnnotatedDataset>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCreateTime() Output only.
int	hashCode()
boolean	hasLabelStats() Output only.
boolean	hasMetadata() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AnnotatedDataset.Builder	newBuilder()
static AnnotatedDataset.Builder	newBuilder(AnnotatedDataset prototype)
AnnotatedDataset.Builder	newBuilderForType()
protected AnnotatedDataset.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static AnnotatedDataset	parseDelimitedFrom(InputStream input)
static AnnotatedDataset	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotatedDataset	parseFrom(byte[] data)
static AnnotatedDataset	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotatedDataset	parseFrom(ByteBuffer data)
static AnnotatedDataset	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotatedDataset	parseFrom(com.google.protobuf.ByteString data)
static AnnotatedDataset	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotatedDataset	parseFrom(com.google.protobuf.CodedInputStream input)
static AnnotatedDataset	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotatedDataset	parseFrom(InputStream input)
static AnnotatedDataset	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AnnotatedDataset>	parser()
AnnotatedDataset.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

ANNOTATION_SOURCE_FIELD_NUMBER

public static final int ANNOTATION_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

ANNOTATION_TYPE_FIELD_NUMBER

public static final int ANNOTATION_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

EXAMPLE_COUNT_FIELD_NUMBER

public static final int EXAMPLE_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

COMPLETED_EXAMPLE_COUNT_FIELD_NUMBER

public static final int COMPLETED_EXAMPLE_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

LABEL_STATS_FIELD_NUMBER

public static final int LABEL_STATS_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

BLOCKING_RESOURCES_FIELD_NUMBER

public static final int BLOCKING_RESOURCES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:

getName in interface AnnotatedDatasetOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Output only. AnnotatedDataset resource name in format of:
 projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
 {annotated_dataset_id}
 

string name = 1;

Specified by:

getNameBytes in interface AnnotatedDatasetOrBuilder

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;

Specified by:

getDisplayName in interface AnnotatedDatasetOrBuilder

getDisplayNameBytes

public com.google.protobuf.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;

Specified by:

getDisplayNameBytes in interface AnnotatedDatasetOrBuilder

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;

Specified by:

getDescription in interface AnnotatedDatasetOrBuilder

getDescriptionBytes

public com.google.protobuf.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;

Specified by:

getDescriptionBytes in interface AnnotatedDatasetOrBuilder

getAnnotationSourceValue

public int getAnnotationSourceValue()

 Output only. Source of the annotation.
 

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

Specified by:

getAnnotationSourceValue in interface AnnotatedDatasetOrBuilder

getAnnotationSource

public AnnotationSource getAnnotationSource()

 Output only. Source of the annotation.
 

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

Specified by:

getAnnotationSource in interface AnnotatedDatasetOrBuilder

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;

Specified by:

getAnnotationTypeValue in interface AnnotatedDatasetOrBuilder

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;

Specified by:

getAnnotationType in interface AnnotatedDatasetOrBuilder

getExampleCount

public long getExampleCount()

 Output only. Number of examples in the annotated dataset.
 

int64 example_count = 4;

Specified by:

getExampleCount in interface AnnotatedDatasetOrBuilder

getCompletedExampleCount

public long getCompletedExampleCount()

 Output only. Number of examples that have annotation in the annotated
 dataset.
 

int64 completed_example_count = 5;

Specified by:

getCompletedExampleCount in interface AnnotatedDatasetOrBuilder

hasLabelStats

public boolean hasLabelStats()

 Output only. Per label statistics.
 

.google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;

Specified by:

hasLabelStats in interface AnnotatedDatasetOrBuilder

getLabelStats

public LabelStats getLabelStats()

 Output only. Per label statistics.
 

.google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;

Specified by:

getLabelStats in interface AnnotatedDatasetOrBuilder

getLabelStatsOrBuilder

public LabelStatsOrBuilder getLabelStatsOrBuilder()

 Output only. Per label statistics.
 

.google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;

Specified by:

getLabelStatsOrBuilder in interface AnnotatedDatasetOrBuilder

hasCreateTime

public boolean hasCreateTime()

 Output only. Time the AnnotatedDataset was created.
 

.google.protobuf.Timestamp create_time = 7;

Specified by:

hasCreateTime in interface AnnotatedDatasetOrBuilder

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. Time the AnnotatedDataset was created.
 

.google.protobuf.Timestamp create_time = 7;

Specified by:

getCreateTime in interface AnnotatedDatasetOrBuilder

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Time the AnnotatedDataset was created.
 

.google.protobuf.Timestamp create_time = 7;

Specified by:

getCreateTimeOrBuilder in interface AnnotatedDatasetOrBuilder

hasMetadata

public boolean hasMetadata()

 Output only. Additional information about AnnotatedDataset.
 

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

Specified by:

hasMetadata in interface AnnotatedDatasetOrBuilder

getMetadata

public AnnotatedDatasetMetadata getMetadata()

 Output only. Additional information about AnnotatedDataset.
 

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

Specified by:

getMetadata in interface AnnotatedDatasetOrBuilder

getMetadataOrBuilder

public AnnotatedDatasetMetadataOrBuilder getMetadataOrBuilder()

 Output only. Additional information about AnnotatedDataset.
 

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

Specified by:

getMetadataOrBuilder in interface AnnotatedDatasetOrBuilder

getBlockingResourcesList

public com.google.protobuf.ProtocolStringList getBlockingResourcesList()

 Output only. The names of any related resources that are blocking changes
 to the annotated dataset.
 

repeated string blocking_resources = 11;

Specified by:

getBlockingResourcesList in interface AnnotatedDatasetOrBuilder

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;

Specified by:

getBlockingResourcesCount in interface AnnotatedDatasetOrBuilder

getBlockingResources

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;

Specified by:

getBlockingResources in interface AnnotatedDatasetOrBuilder

getBlockingResourcesBytes

public com.google.protobuf.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;

Specified by:

getBlockingResourcesBytes in interface AnnotatedDatasetOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AnnotatedDataset parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotatedDataset parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotatedDataset parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotatedDataset parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotatedDataset parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotatedDataset parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotatedDataset parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static AnnotatedDataset parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnnotatedDataset parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnnotatedDataset parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static AnnotatedDataset parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static AnnotatedDataset parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public AnnotatedDataset.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AnnotatedDataset.Builder newBuilder()

newBuilder

public static AnnotatedDataset.Builder newBuilder(AnnotatedDataset prototype)

toBuilder

public AnnotatedDataset.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AnnotatedDataset.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AnnotatedDataset getDefaultInstance()

parser

public static com.google.protobuf.Parser<AnnotatedDataset> parser()

getParserForType

public com.google.protobuf.Parser<AnnotatedDataset> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AnnotatedDataset getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder