Interface AnnotatedDatasetOrBuilder (0.168.0)

public interface AnnotatedDatasetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnnotationSource()

public abstract AnnotationSource getAnnotationSource()

Output only. Source of the annotation.

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

Returns
Type Description
AnnotationSource

The annotationSource.

getAnnotationSourceValue()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the blockingResources.

getCompletedExampleCount()

public abstract 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 abstract Timestamp getCreateTime()

Output only. Time the AnnotatedDataset was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time the AnnotatedDataset was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
TimestampOrBuilder

getDescription()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract long getExampleCount()

Output only. Number of examples in the annotated dataset.

int64 example_count = 4;

Returns
Type Description
long

The exampleCount.

getLabelStats()

public abstract LabelStats getLabelStats()

Output only. Per label statistics.

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

Returns
Type Description
LabelStats

The labelStats.

getLabelStatsOrBuilder()

public abstract LabelStatsOrBuilder getLabelStatsOrBuilder()

Output only. Per label statistics.

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

Returns
Type Description
LabelStatsOrBuilder

getMetadata()

public abstract AnnotatedDatasetMetadata getMetadata()

Output only. Additional information about AnnotatedDataset.

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

Returns
Type Description
AnnotatedDatasetMetadata

The metadata.

getMetadataOrBuilder()

public abstract AnnotatedDatasetMetadataOrBuilder getMetadataOrBuilder()

Output only. Additional information about AnnotatedDataset.

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

Returns
Type Description
AnnotatedDatasetMetadataOrBuilder

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.