list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

Lists DataItems in a Dataset.

Args:
  parent: string, Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
  filter: string, The standard list filter.
  orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
  pageSize: integer, The standard list page size.
  pageToken: string, The standard list page token.
  readMask: string, Mask specifying which fields to read.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for DatasetService.ListDataItems.
  "dataItems": [ # A list of DataItems that matches the specified filter in the request.
    { # A piece of data in a Dataset. Could be an image, a video, a document or plain text.
      "createTime": "A String", # Output only. Timestamp when this DataItem was created.
      "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
      "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.
        "a_key": "A String",
      },
      "name": "A String", # Output only. The resource name of the DataItem.
      "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 metadata schema's dataItemSchemaUri field.
      "satisfiesPzi": True or False, # Output only. Reserved for future use.
      "satisfiesPzs": True or False, # Output only. Reserved for future use.
      "updateTime": "A String", # Output only. Timestamp when this DataItem was last updated.
    },
  ],
  "nextPageToken": "A String", # The standard List next-page token.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

Vertex AI API . projects . locations . datasets . dataItems

Instance Methods

Method Details