Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class AnnotationSpecSet.
An AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, you define a set of possible labels for images as an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation.
Generated from protobuf message google.cloud.datalabeling.v1beta1.AnnotationSpecSet
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}" |
↳ display_name |
string
Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters. |
↳ description |
string
Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long. |
↳ annotation_specs |
array<Google\Cloud\DataLabeling\V1beta1\AnnotationSpec>
Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task. |
↳ blocking_resources |
array
Output only. The names of any related resources that are blocking changes to the annotation spec set. |
getName
Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. User-provided description of the annotation specification set.
The description can be up to 10,000 characters long.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. User-provided description of the annotation specification set.
The description can be up to 10,000 characters long.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnnotationSpecs
Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAnnotationSpecs
Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\DataLabeling\V1beta1\AnnotationSpec>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBlockingResources
Output only. The names of any related resources that are blocking changes to the annotation spec set.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setBlockingResources
Output only. The names of any related resources that are blocking changes to the annotation spec set.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |