Package com.google.cloud.datalabeling.v1beta1

Interface AnnotatedDatasetOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AnnotatedDataset, AnnotatedDataset.Builder
    public interface AnnotatedDatasetOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Output only. AnnotatedDataset resource name in format of:
 projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
 {annotated_dataset_id}
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        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;
        Returns:
        The bytes for name.

      • getDisplayName

        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:
        The displayName.

      • getDisplayNameBytes

        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;
        Returns:
        The bytes for displayName.

      • getDescription

        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:
        The description.

      • getDescriptionBytes

        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;
        Returns:
        The bytes for description.

      • getAnnotationSourceValue

        int getAnnotationSourceValue()
         Output only. Source of the annotation.
        .google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 3;
        Returns:
        The enum numeric value on the wire for annotationSource.

      • getAnnotationSource

        AnnotationSource getAnnotationSource()
         Output only. Source of the annotation.
        .google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 3;
        Returns:
        The annotationSource.

      • getAnnotationTypeValue

        int getAnnotationTypeValue()
         Output only. Type of the annotation. It is specified when starting labeling
 task.
        .google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 8;
        Returns:
        The enum numeric value on the wire for annotationType.

      • getAnnotationType

        AnnotationType getAnnotationType()
         Output only. Type of the annotation. It is specified when starting labeling
 task.
        .google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 8;
        Returns:
        The annotationType.

      • getExampleCount

        long getExampleCount()
         Output only. Number of examples in the annotated dataset.
        int64 example_count = 4;
        Returns:
        The exampleCount.

      • getCompletedExampleCount

        long getCompletedExampleCount()
         Output only. Number of examples that have annotation in the annotated
 dataset.
        int64 completed_example_count = 5;
        Returns:
        The completedExampleCount.

      • hasLabelStats

        boolean hasLabelStats()
         Output only. Per label statistics.
        .google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;
        Returns:
        Whether the labelStats field is set.

      • getLabelStats

        LabelStats getLabelStats()
         Output only. Per label statistics.
        .google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;
        Returns:
        The labelStats.

      • getLabelStatsOrBuilder

        LabelStatsOrBuilder getLabelStatsOrBuilder()
         Output only. Per label statistics.
        .google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Time the AnnotatedDataset was created.
        .google.protobuf.Timestamp create_time = 7;
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Time the AnnotatedDataset was created.
        .google.protobuf.Timestamp create_time = 7;
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Time the AnnotatedDataset was created.
        .google.protobuf.Timestamp create_time = 7;

      • hasMetadata

        boolean hasMetadata()
         Output only. Additional information about AnnotatedDataset.
        .google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata metadata = 10;
        Returns:
        Whether the metadata field is set.

      • getMetadata

        AnnotatedDatasetMetadata getMetadata()
         Output only. Additional information about AnnotatedDataset.
        .google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata metadata = 10;
        Returns:
        The metadata.

      • getMetadataOrBuilder

        AnnotatedDatasetMetadataOrBuilder getMetadataOrBuilder()
         Output only. Additional information about AnnotatedDataset.
        .google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata metadata = 10;

      • getBlockingResourcesList

        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:
        A list containing the blockingResources.

      • getBlockingResourcesCount

        int getBlockingResourcesCount()
         Output only. The names of any related resources that are blocking changes
 to the annotated dataset.
        repeated string blocking_resources = 11;
        Returns:
        The count of blockingResources.

      • getBlockingResources

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The blockingResources at the given index.

      • getBlockingResourcesBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the blockingResources at the given index.