Method: googleapis.aiplatform.v1.projects.locations.metadataStores.executions.list

Lists Executions in the MetadataStore.

Arguments

Parameters
parent

string

Required. The MetadataStore whose Executions should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

filter

string

Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * Attribute filtering: For example: display_name = "test". Supported fields include: name, display_name, state, schema_title, create_time, and update_time. Time fields, such as create_time and update_time, require values specified in RFC-3339 format. For example: create_time = "2020-11-19T11:30:00-04:00". * Metadata field: To filter on metadata fields use traversal operation as follows: metadata.. For example: metadata.field_1.number_value = 10.0 In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: metadata."field:1".number_value = 10.0 * Context based filtering: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: in_context(). For example: in_context("projects//locations//metadataStores//contexts/") Each of the above supported filters can be combined together using logical operators (AND & OR). Maximum nested expression depth allowed is 5. For example: display_name = "test" AND metadata.field1.bool_value = true.

orderBy

string

How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a . character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

pageSize

integer (int32 format)

The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

pageToken

string

A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.)

region

string

Required. Region of the HTTP endpoint. For example, if region is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of GoogleCloudAiplatformV1ListExecutionsResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.aiplatform.v1.projects.locations.metadataStores.executions.list
    args:
        parent: ...
        filter: ...
        orderBy: ...
        pageSize: ...
        pageToken: ...
        region: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.aiplatform.v1.projects.locations.metadataStores.executions.list",
      "args": {
        "parent": "...",
        "filter": "...",
        "orderBy": "...",
        "pageSize": "...",
        "pageToken": "...",
        "region": "..."
      },
      "result": "listResult"
    }
  }
]