push_notification_configs

Creates, updates, deletes, gets or lists a push_notification_configs resource.

Overview

Name	push_notification_configs
Type	Resource
Id	google.discoveryengine.push_notification_configs

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_engines_assistants_agents_a2a_v1_tasks_push_notification_configs_get

Name	Datatype	Description
name	string	The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
pushNotificationConfig	object	The push notification configuration details. (id: A2aV1PushNotificationConfig)

projects_locations_collections_engines_assistants_agents_a2a_v1_tasks_push_notification_configs_list

Name	Datatype	Description
name	string	The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
pushNotificationConfig	object	The push notification configuration details. (id: A2aV1PushNotificationConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_engines_assistants_agents_a2a_v1_tasks_push_notification_configs_get	select	projectsId, locationsId, collectionsId, enginesId, assistantsId, agentsId, tasksId, pushNotificationConfigsId		Get a push notification config for a task.
projects_locations_collections_engines_assistants_agents_a2a_v1_tasks_push_notification_configs_list	select	projectsId, locationsId, collectionsId, enginesId, assistantsId, agentsId, tasksId	pageToken, pageSize	Get a list of push notifications configured for a task.
projects_locations_collections_engines_assistants_agents_a2a_v1_tasks_push_notification_configs_create	insert	projectsId, locationsId, collectionsId, enginesId, assistantsId, agentsId, tasksId	configId	Set a push notification config for a task.
projects_locations_collections_engines_assistants_agents_a2a_v1_tasks_push_notification_configs_delete	delete	projectsId, locationsId, collectionsId, enginesId, assistantsId, agentsId, tasksId, pushNotificationConfigsId		Delete a push notification config for a task.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentsId	string
assistantsId	string
collectionsId	string
enginesId	string
locationsId	string
projectsId	string
pushNotificationConfigsId	string
tasksId	string
configId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_collections_engines_assistants_agents_a2a_v1_tasks_push_notification_configs_get

Get a push notification config for a task.

SELECT
name,
pushNotificationConfig
FROM google.discoveryengine.push_notification_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND enginesId = '{{ enginesId }}' -- required
AND assistantsId = '{{ assistantsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND tasksId = '{{ tasksId }}' -- required
AND pushNotificationConfigsId = '{{ pushNotificationConfigsId }}' -- required
;

projects_locations_collections_engines_assistants_agents_a2a_v1_tasks_push_notification_configs_list

Get a list of push notifications configured for a task.

SELECT
name,
pushNotificationConfig
FROM google.discoveryengine.push_notification_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND enginesId = '{{ enginesId }}' -- required
AND assistantsId = '{{ assistantsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND tasksId = '{{ tasksId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

projects_locations_collections_engines_assistants_agents_a2a_v1_tasks_push_notification_configs_create

Set a push notification config for a task.

INSERT INTO google.discoveryengine.push_notification_configs (
data__name,
data__pushNotificationConfig,
projectsId,
locationsId,
collectionsId,
enginesId,
assistantsId,
agentsId,
tasksId,
configId
)
SELECT 
'{{ name }}',
'{{ pushNotificationConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ collectionsId }}',
'{{ enginesId }}',
'{{ assistantsId }}',
'{{ agentsId }}',
'{{ tasksId }}',
'{{ configId }}'
RETURNING
name,
pushNotificationConfig
;

Manifest

# Description fields are for documentation purposes
- name: push_notification_configs
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the push_notification_configs resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the push_notification_configs resource.
  - name: collectionsId
    value: "{{ collectionsId }}"
    description: Required parameter for the push_notification_configs resource.
  - name: enginesId
    value: "{{ enginesId }}"
    description: Required parameter for the push_notification_configs resource.
  - name: assistantsId
    value: "{{ assistantsId }}"
    description: Required parameter for the push_notification_configs resource.
  - name: agentsId
    value: "{{ agentsId }}"
    description: Required parameter for the push_notification_configs resource.
  - name: tasksId
    value: "{{ tasksId }}"
    description: Required parameter for the push_notification_configs resource.
  - name: name
    value: "{{ name }}"
    description: |
      The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
  - name: pushNotificationConfig
    description: |
      The push notification configuration details.
    value:
      token: "{{ token }}"
      url: "{{ url }}"
      id: "{{ id }}"
      authentication:
        credentials: "{{ credentials }}"
        schemes:
          - "{{ schemes }}"
  - name: configId
    value: "{{ configId }}"

DELETE examples

projects_locations_collections_engines_assistants_agents_a2a_v1_tasks_push_notification_configs_delete

Delete a push notification config for a task.

DELETE FROM google.discoveryengine.push_notification_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND enginesId = '{{ enginesId }}' --required
AND assistantsId = '{{ assistantsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND tasksId = '{{ tasksId }}' --required
AND pushNotificationConfigsId = '{{ pushNotificationConfigsId }}' --required
;