Class AnnotatedDataset.Builder (0.165.0) 

public static final class AnnotatedDataset.Builder extends GeneratedMessageV3.Builder<AnnotatedDataset.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AnnotatedDataset.Builder

Static Methods

getDescriptor()

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

Methods

addAllBlockingResources(Iterable<String> values)

public AnnotatedDataset.Builder addAllBlockingResources(Iterable<String> values)

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

repeated string blocking_resources = 11;

Parameter
Name Description
values Iterable<String>

The blockingResources to add.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

addBlockingResources(String value)

public AnnotatedDataset.Builder addBlockingResources(String value)

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

repeated string blocking_resources = 11;

Parameter
Name Description
value String

The blockingResources to add.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

addBlockingResourcesBytes(ByteString value)

public AnnotatedDataset.Builder addBlockingResourcesBytes(ByteString value)

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

repeated string blocking_resources = 11;

Parameter
Name Description
value ByteString

The bytes of the blockingResources to add.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AnnotatedDataset.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnnotatedDataset.Builder
Overrides

build()

public AnnotatedDataset build()
Returns
Type Description
AnnotatedDataset

buildPartial()

public AnnotatedDataset buildPartial()
Returns
Type Description
AnnotatedDataset

clear()

public AnnotatedDataset.Builder clear()
Returns
Type Description
AnnotatedDataset.Builder
Overrides

clearAnnotationSource()

public AnnotatedDataset.Builder clearAnnotationSource()

Output only. Source of the annotation.

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

Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

clearAnnotationType()

public AnnotatedDataset.Builder clearAnnotationType()

Output only. Type of the annotation. It is specified when starting labeling task.

.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 8;

Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

clearBlockingResources()

public AnnotatedDataset.Builder clearBlockingResources()

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

repeated string blocking_resources = 11;

Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

clearCompletedExampleCount()

public AnnotatedDataset.Builder clearCompletedExampleCount()

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

int64 completed_example_count = 5;

Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

clearCreateTime()

public AnnotatedDataset.Builder clearCreateTime()

Output only. Time the AnnotatedDataset was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
AnnotatedDataset.Builder

clearDescription()

public AnnotatedDataset.Builder clearDescription()

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
AnnotatedDataset.Builder

This builder for chaining.

clearDisplayName()

public AnnotatedDataset.Builder clearDisplayName()

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
AnnotatedDataset.Builder

This builder for chaining.

clearExampleCount()

public AnnotatedDataset.Builder clearExampleCount()

Output only. Number of examples in the annotated dataset.

int64 example_count = 4;

Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AnnotatedDataset.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AnnotatedDataset.Builder
Overrides

clearLabelStats()

public AnnotatedDataset.Builder clearLabelStats()

Output only. Per label statistics.

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

Returns
Type Description
AnnotatedDataset.Builder

clearMetadata()

public AnnotatedDataset.Builder clearMetadata()

Output only. Additional information about AnnotatedDataset.

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

Returns
Type Description
AnnotatedDataset.Builder

clearName()

public AnnotatedDataset.Builder clearName()

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

string name = 1;

Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AnnotatedDataset.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AnnotatedDataset.Builder
Overrides

clone()

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

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time the AnnotatedDataset was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getLabelStatsBuilder()

public LabelStats.Builder getLabelStatsBuilder()

Output only. Per label statistics.

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

Returns
Type Description
LabelStats.Builder

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.

getMetadataBuilder()

public AnnotatedDatasetMetadata.Builder getMetadataBuilder()

Output only. Additional information about AnnotatedDataset.

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

Returns
Type Description
AnnotatedDatasetMetadata.Builder

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public AnnotatedDataset.Builder mergeCreateTime(Timestamp value)

Output only. Time the AnnotatedDataset was created.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name Description
value Timestamp
Returns
Type Description
AnnotatedDataset.Builder

mergeFrom(AnnotatedDataset other)

public AnnotatedDataset.Builder mergeFrom(AnnotatedDataset other)
Parameter
Name Description
other AnnotatedDataset
Returns
Type Description
AnnotatedDataset.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AnnotatedDataset.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotatedDataset.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AnnotatedDataset.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AnnotatedDataset.Builder
Overrides

mergeLabelStats(LabelStats value)

public AnnotatedDataset.Builder mergeLabelStats(LabelStats value)

Output only. Per label statistics.

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

Parameter
Name Description
value LabelStats
Returns
Type Description
AnnotatedDataset.Builder

mergeMetadata(AnnotatedDatasetMetadata value)

public AnnotatedDataset.Builder mergeMetadata(AnnotatedDatasetMetadata value)

Output only. Additional information about AnnotatedDataset.

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

Parameter
Name Description
value AnnotatedDatasetMetadata
Returns
Type Description
AnnotatedDataset.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AnnotatedDataset.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnnotatedDataset.Builder
Overrides

setAnnotationSource(AnnotationSource value)

public AnnotatedDataset.Builder setAnnotationSource(AnnotationSource value)

Output only. Source of the annotation.

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

Parameter
Name Description
value AnnotationSource

The annotationSource to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setAnnotationSourceValue(int value)

public AnnotatedDataset.Builder setAnnotationSourceValue(int value)

Output only. Source of the annotation.

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

Parameter
Name Description
value int

The enum numeric value on the wire for annotationSource to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setAnnotationType(AnnotationType value)

public AnnotatedDataset.Builder setAnnotationType(AnnotationType value)

Output only. Type of the annotation. It is specified when starting labeling task.

.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 8;

Parameter
Name Description
value AnnotationType

The annotationType to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setAnnotationTypeValue(int value)

public AnnotatedDataset.Builder setAnnotationTypeValue(int value)

Output only. Type of the annotation. It is specified when starting labeling task.

.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 8;

Parameter
Name Description
value int

The enum numeric value on the wire for annotationType to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setBlockingResources(int index, String value)

public AnnotatedDataset.Builder setBlockingResources(int index, String value)

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

repeated string blocking_resources = 11;

Parameters
Name Description
index int

The index to set the value at.
value String

The blockingResources to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setCompletedExampleCount(long value)

public AnnotatedDataset.Builder setCompletedExampleCount(long value)

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

int64 completed_example_count = 5;

Parameter
Name Description
value long

The completedExampleCount to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public AnnotatedDataset.Builder setCreateTime(Timestamp value)

Output only. Time the AnnotatedDataset was created.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name Description
value Timestamp
Returns
Type Description
AnnotatedDataset.Builder

setCreateTime(Timestamp.Builder builderForValue)

public AnnotatedDataset.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time the AnnotatedDataset was created.

.google.protobuf.Timestamp create_time = 7;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AnnotatedDataset.Builder

setDescription(String value)

public AnnotatedDataset.Builder setDescription(String value)

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;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public AnnotatedDataset.Builder setDescriptionBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setDisplayName(String value)

public AnnotatedDataset.Builder setDisplayName(String value)

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;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public AnnotatedDataset.Builder setDisplayNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setExampleCount(long value)

public AnnotatedDataset.Builder setExampleCount(long value)

Output only. Number of examples in the annotated dataset.

int64 example_count = 4;

Parameter
Name Description
value long

The exampleCount to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AnnotatedDataset.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnnotatedDataset.Builder
Overrides

setLabelStats(LabelStats value)

public AnnotatedDataset.Builder setLabelStats(LabelStats value)

Output only. Per label statistics.

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

Parameter
Name Description
value LabelStats
Returns
Type Description
AnnotatedDataset.Builder

setLabelStats(LabelStats.Builder builderForValue)

public AnnotatedDataset.Builder setLabelStats(LabelStats.Builder builderForValue)

Output only. Per label statistics.

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

Parameter
Name Description
builderForValue LabelStats.Builder
Returns
Type Description
AnnotatedDataset.Builder

setMetadata(AnnotatedDatasetMetadata value)

public AnnotatedDataset.Builder setMetadata(AnnotatedDatasetMetadata value)

Output only. Additional information about AnnotatedDataset.

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

Parameter
Name Description
value AnnotatedDatasetMetadata
Returns
Type Description
AnnotatedDataset.Builder

setMetadata(AnnotatedDatasetMetadata.Builder builderForValue)

public AnnotatedDataset.Builder setMetadata(AnnotatedDatasetMetadata.Builder builderForValue)

Output only. Additional information about AnnotatedDataset.

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

Parameter
Name Description
builderForValue AnnotatedDatasetMetadata.Builder
Returns
Type Description
AnnotatedDataset.Builder

setName(String value)

public AnnotatedDataset.Builder setName(String value)

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

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AnnotatedDataset.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
AnnotatedDataset.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AnnotatedDataset.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AnnotatedDataset.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AnnotatedDataset.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnnotatedDataset.Builder
Overrides