Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class AnnotatedDataset.
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.
Generated from protobuf messagegoogle.cloud.datalabeling.v1beta1.AnnotatedDataset
Namespace
Google \ Cloud \ DataLabeling \ V1beta1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
↳ display_name
string
Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.
↳ description
string
Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters.
↳ annotation_source
int
Output only. Source of the annotation.
↳ annotation_type
int
Output only. Type of the annotation. It is specified when starting labeling task.
↳ example_count
int|string
Output only. Number of examples in the annotated dataset.
↳ completed_example_count
int|string
Output only. Number of examples that have annotation in the annotated dataset.
Output only. Additional information about AnnotatedDataset.
↳ blocking_resources
array
Output only. The names of any related resources that are blocking changes to the annotated dataset.
getName
Output only. AnnotatedDataset resource name in format of:
projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
{annotated_dataset_id}
Returns
Type
Description
string
setName
Output only. AnnotatedDataset resource name in format of:
projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
{annotated_dataset_id}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
Output only. The display name of the AnnotatedDataset. It is specified in
HumanAnnotationConfig when user starts a labeling task. Maximum of 64
characters.
Returns
Type
Description
string
setDisplayName
Output only. The display name of the AnnotatedDataset. It is specified in
HumanAnnotationConfig when user starts a labeling task. Maximum of 64
characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
Output only. The description of the AnnotatedDataset. It is specified in
HumanAnnotationConfig when user starts a labeling task. Maximum of 10000
characters.
Returns
Type
Description
string
setDescription
Output only. The description of the AnnotatedDataset. It is specified in
HumanAnnotationConfig when user starts a labeling task. Maximum of 10000
characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAnnotationSource
Output only. Source of the annotation.
Returns
Type
Description
int
setAnnotationSource
Output only. Source of the annotation.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getAnnotationType
Output only. Type of the annotation. It is specified when starting labeling
task.
Returns
Type
Description
int
setAnnotationType
Output only. Type of the annotation. It is specified when starting labeling
task.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getExampleCount
Output only. Number of examples in the annotated dataset.
Returns
Type
Description
int|string
setExampleCount
Output only. Number of examples in the annotated dataset.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getCompletedExampleCount
Output only. Number of examples that have annotation in the annotated
dataset.
Returns
Type
Description
int|string
setCompletedExampleCount
Output only. Number of examples that have annotation in the annotated
dataset.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Datalabeling V1beta1 Client - Class AnnotatedDataset (0.6.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.3 (latest)](/php/docs/reference/cloud-datalabeling/latest/V1beta1.AnnotatedDataset)\n- [0.6.2](/php/docs/reference/cloud-datalabeling/0.6.2/V1beta1.AnnotatedDataset)\n- [0.5.7](/php/docs/reference/cloud-datalabeling/0.5.7/V1beta1.AnnotatedDataset)\n- [0.4.2](/php/docs/reference/cloud-datalabeling/0.4.2/V1beta1.AnnotatedDataset)\n- [0.3.1](/php/docs/reference/cloud-datalabeling/0.3.1/V1beta1.AnnotatedDataset)\n- [0.2.0](/php/docs/reference/cloud-datalabeling/0.2.0/V1beta1.AnnotatedDataset)\n- [0.1.14](/php/docs/reference/cloud-datalabeling/0.1.14/V1beta1.AnnotatedDataset) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class AnnotatedDataset.\n\nAnnotatedDataset is a set holding annotations for data in a Dataset. Each\nlabeling task will generate an AnnotatedDataset under the Dataset that the\ntask is requested for.\n\nGenerated from protobuf message `google.cloud.datalabeling.v1beta1.AnnotatedDataset`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DataLabeling \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. AnnotatedDataset resource name in format of:\nprojects/{project_id}/datasets/{dataset_id}/annotatedDatasets/\n{annotated_dataset_id}\n\n### setName\n\nOutput only. AnnotatedDataset resource name in format of:\nprojects/{project_id}/datasets/{dataset_id}/annotatedDatasets/\n{annotated_dataset_id}\n\n### getDisplayName\n\nOutput only. The display name of the AnnotatedDataset. It is specified in\nHumanAnnotationConfig when user starts a labeling task. Maximum of 64\ncharacters.\n\n### setDisplayName\n\nOutput only. The display name of the AnnotatedDataset. It is specified in\nHumanAnnotationConfig when user starts a labeling task. Maximum of 64\ncharacters.\n\n### getDescription\n\nOutput only. The description of the AnnotatedDataset. It is specified in\nHumanAnnotationConfig when user starts a labeling task. Maximum of 10000\ncharacters.\n\n### setDescription\n\nOutput only. The description of the AnnotatedDataset. It is specified in\nHumanAnnotationConfig when user starts a labeling task. Maximum of 10000\ncharacters.\n\n### getAnnotationSource\n\nOutput only. Source of the annotation.\n\n### setAnnotationSource\n\nOutput only. Source of the annotation.\n\n### getAnnotationType\n\nOutput only. Type of the annotation. It is specified when starting labeling\ntask.\n\n### setAnnotationType\n\nOutput only. Type of the annotation. It is specified when starting labeling\ntask.\n\n### getExampleCount\n\nOutput only. Number of examples in the annotated dataset.\n\n### setExampleCount\n\nOutput only. Number of examples in the annotated dataset.\n\n### getCompletedExampleCount\n\nOutput only. Number of examples that have annotation in the annotated\ndataset.\n\n### setCompletedExampleCount\n\nOutput only. Number of examples that have annotation in the annotated\ndataset.\n\n### getLabelStats\n\nOutput only. Per label statistics.\n\n### hasLabelStats\n\n### clearLabelStats\n\n### setLabelStats\n\nOutput only. Per label statistics.\n\n### getCreateTime\n\nOutput only. Time the AnnotatedDataset was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. Time the AnnotatedDataset was created.\n\n### getMetadata\n\nOutput only. Additional information about AnnotatedDataset.\n\n### hasMetadata\n\n### clearMetadata\n\n### setMetadata\n\nOutput only. Additional information about AnnotatedDataset.\n\n### getBlockingResources\n\nOutput only. The names of any related resources that are blocking changes\nto the annotated dataset.\n\n### setBlockingResources\n\nOutput only. The names of any related resources that are blocking changes\nto the annotated dataset."]]
