Lists DataItems in a Dataset.
HTTP request
GET https://{service-endpoint}/v1beta1/{parent}/dataItems
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the Dataset to list DataItems from. Format: |
Query parameters
Parameters | |
---|---|
filter |
The standard list filter. |
pageSize |
The standard list page size. |
pageToken |
The standard list page token. |
readMask |
Mask specifying which fields to read. This is a comma-separated list of fully qualified names of fields. Example: |
orderBy |
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message for DatasetService.ListDataItems
.
JSON representation |
---|
{
"dataItems": [
{
object ( |
Fields | |
---|---|
dataItems[] |
A list of DataItems that matches the specified filter in the request. |
nextPageToken |
The standard List next-page token. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
aiplatform.dataItems.list
For more information, see the IAM documentation.
DataItem
A piece of data in a Dataset. Could be an image, a video, a document or plain text.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "payload": value, "etag": string } |
Fields | |
---|---|
name |
Output only. The resource name of the DataItem. |
createTime |
Output only. Timestamp when this DataItem was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Timestamp when this DataItem was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Optional. The labels with user-defined metadata to organize your DataItems. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one DataItem(System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
payload |
Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's |
etag |
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |