Google Cloud Datalabeling V1beta1 Client - Class Dataset (0.5.5)

Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class Dataset.

Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.

Generated from protobuf message google.cloud.datalabeling.v1beta1.Dataset

Namespace

Google \ Cloud \ DataLabeling \ V1beta1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
`↳ display_name`	`string` Required. The display name of the dataset. Maximum of 64 characters.
`↳ description`	`string` Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Time the dataset is created.
`↳ input_configs`	`array<Google\Cloud\DataLabeling\V1beta1\InputConfig>` Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.
`↳ blocking_resources`	`array` Output only. The names of any related resources that are blocking changes to the dataset.
`↳ data_item_count`	`int\|string` Output only. The number of data items in the dataset.

getName

Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}

Returns
Type	Description
`string`

setName

Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Required. The display name of the dataset. Maximum of 64 characters.

Returns
Type	Description
`string`

setDisplayName

Required. The display name of the dataset. 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 10000 characters long.

Returns
Type	Description
`string`

setDescription

Optional. User-provided description of the annotation specification set.

The description can be up to 10000 characters long.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Time the dataset is created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time the dataset is created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getInputConfigs

Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setInputConfigs

Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.

Parameter
Name	Description
`var`	`array<Google\Cloud\DataLabeling\V1beta1\InputConfig>`

Returns
Type	Description
`$this`

getBlockingResources

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setBlockingResources

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

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getDataItemCount

Output only. The number of data items in the dataset.

Returns
Type	Description
`int\|string`

setDataItemCount

Output only. The number of data items in the dataset.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`