Agent Platform API . projects . locations . taskStores . a2aTaskRecords . events

close()

Close httplib2 connections.

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

Lists TaskEvents for an A2ATaskRecord.

Args:
  parent: string, Required. The resource name of the A2ATaskRecord to list the TaskEvents under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}` (required)
  filter: string, Optional. The standard list filter. Supported fields: * `create_time` range (i.e. `create_time>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).
  orderBy: string, Optional. A comma-separated list of fields to order the results by. If this field is omitted, the results will be ordered by `generation` in ascending order. For each field, the default sort order is ascending. To specify descending order for a field, append a ` desc` suffix. For example: `create_time desc`. Supported fields: * `create_time` * `generation`
  pageSize: integer, Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  pageToken: string, Optional. The next_page_token value returned from a previous list A2ATaskRecordService.ListA2ATaskRecordEvents call.
  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 A2ATaskRecordService.ListA2ATaskRecordEvents.
  "events": [ # List of A2ATaskRecordEvents in the requested page.
    { # An event that records a single change applied to a task's state.
      "createTime": "A String", # Output only. The time at which the event was created.
      "eventData": { # The data describing the change carried by an A2ATaskRecordEvent. Multiple changes can be set in a single event. # Required. The data describing the change carried by this event.
        "artifactChange": { # An event payload describing a change to one of the task's artifacts. # Optional. A change to one of the task's artifacts.
          "append": True or False, # Optional. Whether the artifact parts should be appended to an existing artifact rather than replacing it.
          "artifact": { # Represents a single artifact produced by a task. # Required. The artifact that was added or updated.
            "artifactId": "A String", # Required. The unique identifier of the artifact within the task.
            "description": "A String", # Optional. A human-readable description of the artifact.
            "displayName": "A String", # Optional. The human-readable name of the artifact.
            "extensions": [ # Optional. A2A protocol extensions associated with the artifact.
              "A String",
            ],
            "metadata": { # Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases.
              "a_key": "", # Properties of the object.
            },
            "parts": [ # Required. The content parts that make up the artifact.
              { # A single part of a message or artifact. A part carries exactly one kind of content.
                "data": "", # Optional. Arbitrary data content.
                "filename": "A String", # Optional. The name of the file, when the part represents a file.
                "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
                "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
                  "a_key": "", # Properties of the object.
                },
                "raw": "A String", # Optional. Raw binary content.
                "text": "A String", # Optional. Textual content.
                "url": "A String", # Optional. A URL pointing to the content.
              },
            ],
          },
          "lastChunk": True or False, # Optional. Whether this is the last chunk of a streamed artifact.
        },
        "historyAppend": { # An event payload that appends a new message to the task history. # Optional. A new message appended to the task history.
          "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Required. The message to append to the task history.
            "extensions": [ # Optional. A2A protocol extensions associated with the message.
              "A String",
            ],
            "messageId": "A String", # Required. The unique identifier of the message.
            "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
              "a_key": "", # Properties of the object.
            },
            "parts": [ # Required. The content parts that make up the message.
              { # A single part of a message or artifact. A part carries exactly one kind of content.
                "data": "", # Optional. Arbitrary data content.
                "filename": "A String", # Optional. The name of the file, when the part represents a file.
                "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
                "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
                  "a_key": "", # Properties of the object.
                },
                "raw": "A String", # Optional. Raw binary content.
                "text": "A String", # Optional. Textual content.
                "url": "A String", # Optional. A URL pointing to the content.
              },
            ],
            "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
              "A String",
            ],
            "role": "A String", # Required. The role of the sender of the message.
          },
        },
        "metadataChange": { # An event payload describing a change to the task-level metadata. # Optional. A change to the task-level metadata.
          "metadata": { # Required. The updated task metadata after the change. This is a partial update that will be merged with the existing metadata.
            "a_key": "", # Properties of the object.
          },
          "updateMask": "A String", # Optional. A field mask indicating which metadata paths changed. If unset, all fields are updated.
        },
        "statusUpdate": { # An event payload that updates the task's state and optional status message. # Optional. An update to the task's state and status message.
          "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The status message associated with the state change.
            "extensions": [ # Optional. A2A protocol extensions associated with the message.
              "A String",
            ],
            "messageId": "A String", # Required. The unique identifier of the message.
            "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
              "a_key": "", # Properties of the object.
            },
            "parts": [ # Required. The content parts that make up the message.
              { # A single part of a message or artifact. A part carries exactly one kind of content.
                "data": "", # Optional. Arbitrary data content.
                "filename": "A String", # Optional. The name of the file, when the part represents a file.
                "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
                "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
                  "a_key": "", # Properties of the object.
                },
                "raw": "A String", # Optional. Raw binary content.
                "text": "A String", # Optional. Textual content.
                "url": "A String", # Optional. A URL pointing to the content.
              },
            ],
            "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
              "A String",
            ],
            "role": "A String", # Required. The role of the sender of the message.
          },
          "state": "A String", # Required. The new state of the task.
          "timestamp": "A String", # Optional. The time at which the status change occurred.
        },
      },
      "generation": "A String", # Output only. The generation number of the task after this event is applied.
      "metadata": { # Optional. Additional context or parameters related to the event. Extensions can be used to strongly type metadata values for specific use cases.
        "a_key": "", # Properties of the object.
      },
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results.
}

list_next(previous_request, previous_response)

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.