google-api-python-client 2.186.0__py3-none-any.whl → 2.188.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/workspaceevents.v1.json

@@ -159,6 +159,25 @@
 },
 "protocol": "rest",
 "resources": {
+"message": {
+"methods": {
+"stream": {
+"description": "SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.",
+"flatPath": "v1/message:stream",
+"httpMethod": "POST",
+"id": "workspaceevents.message.stream",
+"parameterOrder": [],
+"parameters": {},
+"path": "v1/message:stream",
+"request": {
+"$ref": "SendMessageRequest"
+},
+"response": {
+"$ref": "StreamResponse"
+}
+}
+}
+},
 "operations": {
 "methods": {
 "get": {
@@ -490,11 +509,342 @@
 ]
 }
 }
+},
+"tasks": {
+"methods": {
+"cancel": {
+"description": "Cancel a task from the agent. If supported one should expect no more task updates for the task.",
+"flatPath": "v1/tasks/{tasksId}:cancel",
+"httpMethod": "POST",
+"id": "workspaceevents.tasks.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The resource name of the task to cancel. Format: tasks/{task_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"request": {
+"$ref": "CancelTaskRequest"
+},
+"response": {
+"$ref": "Task"
 }
 },
-"revision": "20250930",
+"get": {
+"description": "Get the current state of a task from the agent.",
+"flatPath": "v1/tasks/{tasksId}",
+"httpMethod": "GET",
+"id": "workspaceevents.tasks.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"historyLength": {
+"description": "The number of most recent messages from the task's history to retrieve.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"name": {
+"description": "Required. The resource name of the task. Format: tasks/{task_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Task"
+}
+},
+"subscribe": {
+"description": "TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream.",
+"flatPath": "v1/tasks/{tasksId}:subscribe",
+"httpMethod": "GET",
+"id": "workspaceevents.tasks.subscribe",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The resource name of the task to subscribe to. Format: tasks/{task_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:subscribe",
+"response": {
+"$ref": "StreamResponse"
+}
+}
+},
+"resources": {
+"pushNotificationConfigs": {
+"methods": {
+"create": {
+"description": "Set a push notification config for a task.",
+"flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs",
+"httpMethod": "POST",
+"id": "workspaceevents.tasks.pushNotificationConfigs.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"configId": {
+"description": "Required. The ID for the new config.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent task resource for this config. Format: tasks/{task_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+/pushNotificationConfigs$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}",
+"request": {
+"$ref": "TaskPushNotificationConfig"
+},
+"response": {
+"$ref": "TaskPushNotificationConfig"
+}
+},
+"delete": {
+"description": "Delete a push notification config for a task.",
+"flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}",
+"httpMethod": "DELETE",
+"id": "workspaceevents.tasks.pushNotificationConfigs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The resource name of the config to delete. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Empty"
+}
+},
+"get": {
+"description": "Get a push notification config for a task.",
+"flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}",
+"httpMethod": "GET",
+"id": "workspaceevents.tasks.pushNotificationConfigs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The resource name of the config to retrieve. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "TaskPushNotificationConfig"
+}
+},
+"list": {
+"description": "Get a list of push notifications configured for a task.",
+"flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs",
+"httpMethod": "GET",
+"id": "workspaceevents.tasks.pushNotificationConfigs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "For AIP-158 these fields are present. Usually not used/needed. The maximum number of configurations to return. If unspecified, all configs will be returned.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token received from a previous ListTaskPushNotificationConfigRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTaskPushNotificationConfigRequest` must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "The parent task resource. Format: tasks/{task_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/pushNotificationConfigs",
+"response": {
+"$ref": "ListTaskPushNotificationConfigResponse"
+}
+}
+}
+}
+}
+}
+},
+"revision": "20251216",
 "rootUrl": "https://workspaceevents.googleapis.com/",
 "schemas": {
+"Artifact": {
+"description": "Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication.",
+"id": "Artifact",
+"properties": {
+"artifactId": {
+"description": "Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.",
+"type": "string"
+},
+"description": {
+"description": "A human readable description of the artifact, optional.",
+"type": "string"
+},
+"extensions": {
+"description": "The URIs of extensions that are present or contributed to this Artifact.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional metadata included with the artifact.",
+"type": "object"
+},
+"name": {
+"description": "A human readable name for the artifact.",
+"type": "string"
+},
+"parts": {
+"description": "The content of the artifact.",
+"items": {
+"$ref": "Part"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"AuthenticationInfo": {
+"description": "Defines authentication details, used for push notifications.",
+"id": "AuthenticationInfo",
+"properties": {
+"credentials": {
+"description": "Optional credentials",
+"type": "string"
+},
+"schemes": {
+"description": "Supported authentication schemes - e.g. Basic, Bearer, etc",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"CancelTaskRequest": {
+"id": "CancelTaskRequest",
+"properties": {
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"DataPart": {
+"description": "DataPart represents a structured blob. This is most commonly a JSON payload.",
+"id": "DataPart",
+"properties": {
+"data": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+}
+},
+"type": "object"
+},
+"Empty": {
+"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
+"id": "Empty",
+"properties": {},
+"type": "object"
+},
+"FilePart": {
+"description": "FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.",
+"id": "FilePart",
+"properties": {
+"fileWithBytes": {
+"format": "byte",
+"type": "string"
+},
+"fileWithUri": {
+"type": "string"
+},
+"mimeType": {
+"type": "string"
+},
+"name": {
+"type": "string"
+}
+},
+"type": "object"
+},
 "ListSubscriptionsResponse": {
 "description": "The response message for SubscriptionsService.ListSubscriptions.",
 "id": "ListSubscriptionsResponse",
@@ -513,6 +863,78 @@
 },
 "type": "object"
 },
+"ListTaskPushNotificationConfigResponse": {
+"id": "ListTaskPushNotificationConfigResponse",
+"properties": {
+"configs": {
+"description": "The list of push notification configurations.",
+"items": {
+"$ref": "TaskPushNotificationConfig"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Message": {
+"description": "Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.",
+"id": "Message",
+"properties": {
+"content": {
+"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.",
+"items": {
+"$ref": "Part"
+},
+"type": "array"
+},
+"contextId": {
+"description": "The context id of the message. This is optional and if set, the message will be associated with the given context.",
+"type": "string"
+},
+"extensions": {
+"description": "The URIs of extensions that are present or contributed to this Message.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"messageId": {
+"description": "The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.",
+"type": "string"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.",
+"type": "object"
+},
+"role": {
+"description": "A role for the message.",
+"enum": [
+"ROLE_UNSPECIFIED",
+"ROLE_USER",
+"ROLE_AGENT"
+],
+"enumDescriptions": [
+"",
+"USER role refers to communication from the client to the server.",
+"AGENT role refers to communication from the server to the client."
+],
+"type": "string"
+},
+"taskId": {
+"description": "The task id of the message. This is optional and if set, the message will be associated with the given task.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "NotificationEndpoint": {
 "description": "The endpoint where the subscription delivers events.",
 "id": "NotificationEndpoint",
@@ -559,6 +981,30 @@
 },
 "type": "object"
 },
+"Part": {
+"description": "Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).",
+"id": "Part",
+"properties": {
+"data": {
+"$ref": "DataPart"
+},
+"file": {
+"$ref": "FilePart"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional metadata associated with this part.",
+"type": "object"
+},
+"text": {
+"type": "string"
+}
+},
+"type": "object"
+},
 "PayloadOptions": {
 "description": "Options about what data to include in the event payload. Only supported for Google Chat and Google Drive events.",
 "id": "PayloadOptions",
@@ -575,12 +1021,89 @@
 },
 "type": "object"
 },
+"PushNotificationConfig": {
+"description": "Configuration for setting up push notifications for task updates.",
+"id": "PushNotificationConfig",
+"properties": {
+"authentication": {
+"$ref": "AuthenticationInfo",
+"description": "Information about the authentication to sent with the notification"
+},
+"id": {
+"description": "A unique identifier (e.g. UUID) for this push notification.",
+"type": "string"
+},
+"token": {
+"description": "Token unique for this task/session",
+"type": "string"
+},
+"url": {
+"description": "Url to send the notification too",
+"type": "string"
+}
+},
+"type": "object"
+},
 "ReactivateSubscriptionRequest": {
 "description": "The request message for SubscriptionsService.ReactivateSubscription.",
 "id": "ReactivateSubscriptionRequest",
 "properties": {},
 "type": "object"
 },
+"SendMessageConfiguration": {
+"description": "Configuration of a send message request.",
+"id": "SendMessageConfiguration",
+"properties": {
+"acceptedOutputModes": {
+"description": "The output modes that the agent is expected to respond with.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"blocking": {
+"description": "If true, the message will be blocking until the task is completed. If false, the message will be non-blocking and the task will be returned immediately. It is the caller's responsibility to check for any task updates.",
+"type": "boolean"
+},
+"historyLength": {
+"description": "The maximum number of messages to include in the history. if 0, the history will be unlimited.",
+"format": "int32",
+"type": "integer"
+},
+"pushNotification": {
+"$ref": "PushNotificationConfig",
+"description": "A configuration of a webhook that can be used to receive updates"
+}
+},
+"type": "object"
+},
+"SendMessageRequest": {
+"description": "/////////// Request Messages ///////////",
+"id": "SendMessageRequest",
+"properties": {
+"configuration": {
+"$ref": "SendMessageConfiguration",
+"description": "Configuration for the send request."
+},
+"message": {
+"$ref": "Message",
+"description": "Required. The message to send to the agent."
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional metadata for the request.",
+"type": "object"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Status": {
 "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
 "id": "Status",
@@ -608,6 +1131,25 @@
 },
 "type": "object"
 },
+"StreamResponse": {
+"description": "The stream response for a message. The stream should be one of the following sequences: If the response is a message, the stream should contain one, and only one, message and then close If the response is a task lifecycle, the first response should be a Task object followed by zero or more TaskStatusUpdateEvents and TaskArtifactUpdateEvents. The stream should complete when the Task if in an interrupted or terminal state. A stream that ends before these conditions are met are",
+"id": "StreamResponse",
+"properties": {
+"artifactUpdate": {
+"$ref": "TaskArtifactUpdateEvent"
+},
+"message": {
+"$ref": "Message"
+},
+"statusUpdate": {
+"$ref": "TaskStatusUpdateEvent"
+},
+"task": {
+"$ref": "Task"
+}
+},
+"type": "object"
+},
 "Subscription": {
 "description": "A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the [Google Workspace Events API overview](https://developers.google.com/workspace/events).",
 "id": "Subscription",
@@ -720,6 +1262,169 @@
 }
 },
 "type": "object"
+},
+"Task": {
+"description": "Task is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.",
+"id": "Task",
+"properties": {
+"artifacts": {
+"description": "A set of output artifacts for a Task.",
+"items": {
+"$ref": "Artifact"
+},
+"type": "array"
+},
+"contextId": {
+"description": "Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). Created by the A2A server.",
+"type": "string"
+},
+"history": {
+"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a task.",
+"items": {
+"$ref": "Message"
+},
+"type": "array"
+},
+"id": {
+"description": "Unique identifier (e.g. UUID) for the task, generated by the server for a new task.",
+"type": "string"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.",
+"type": "object"
+},
+"status": {
+"$ref": "TaskStatus",
+"description": "The current status of a Task, including state and a message."
+}
+},
+"type": "object"
+},
+"TaskArtifactUpdateEvent": {
+"description": "TaskArtifactUpdateEvent represents a task delta where an artifact has been generated.",
+"id": "TaskArtifactUpdateEvent",
+"properties": {
+"append": {
+"description": "Whether this should be appended to a prior one produced",
+"type": "boolean"
+},
+"artifact": {
+"$ref": "Artifact",
+"description": "The artifact itself"
+},
+"contextId": {
+"description": "The id of the context that this task belongs too",
+"type": "string"
+},
+"lastChunk": {
+"description": "Whether this represents the last part of an artifact",
+"type": "boolean"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional metadata associated with the artifact update.",
+"type": "object"
+},
+"taskId": {
+"description": "The id of the task for this artifact",
+"type": "string"
+}
+},
+"type": "object"
+},
+"TaskPushNotificationConfig": {
+"id": "TaskPushNotificationConfig",
+"properties": {
+"name": {
+"description": "The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}",
+"type": "string"
+},
+"pushNotificationConfig": {
+"$ref": "PushNotificationConfig",
+"description": "The push notification configuration details."
+}
+},
+"type": "object"
+},
+"TaskStatus": {
+"description": "A container for the status of a task",
+"id": "TaskStatus",
+"properties": {
+"message": {
+"$ref": "Message",
+"description": "A message associated with the status."
+},
+"state": {
+"description": "The current state of this task",
+"enum": [
+"TASK_STATE_UNSPECIFIED",
+"TASK_STATE_SUBMITTED",
+"TASK_STATE_WORKING",
+"TASK_STATE_COMPLETED",
+"TASK_STATE_FAILED",
+"TASK_STATE_CANCELLED",
+"TASK_STATE_INPUT_REQUIRED",
+"TASK_STATE_REJECTED",
+"TASK_STATE_AUTH_REQUIRED"
+],
+"enumDescriptions": [
+"",
+"Represents the status that acknowledges a task is created",
+"Represents the status that a task is actively being processed",
+"Represents the status a task is finished. This is a terminal state",
+"Represents the status a task is done but failed. This is a terminal state",
+"Represents the status a task was cancelled before it finished. This is a terminal state.",
+"Represents the status that the task requires information to complete. This is an interrupted state.",
+"Represents the status that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.",
+"Represents the state that some authentication is needed from the upstream client. Authentication is expected to come out-of-band thus this is not an interrupted or terminal state."
+],
+"type": "string"
+},
+"timestamp": {
+"description": "Timestamp when the status was recorded. Example: \"2023-10-27T10:00:00Z\"",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"TaskStatusUpdateEvent": {
+"description": "TaskStatusUpdateEvent is a delta even on a task indicating that a task has changed.",
+"id": "TaskStatusUpdateEvent",
+"properties": {
+"contextId": {
+"description": "The id of the context that the task belongs to",
+"type": "string"
+},
+"final": {
+"description": "Whether this is the last status update expected for this task.",
+"type": "boolean"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional metadata to associate with the task update.",
+"type": "object"
+},
+"status": {
+"$ref": "TaskStatus",
+"description": "The new status of the task."
+},
+"taskId": {
+"description": "The id of the task that is changed",
+"type": "string"
+}
+},
+"type": "object"
 }
 },
 "servicePath": "",