actions

Creates, updates, deletes, gets or lists an actions resource.

Overview

Name	actions
Type	Resource
Id	google.connectors.actions

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Name of the action.
description	string	Brief Description of action
displayName	string	Display Name of action to be shown on client side
inputJsonSchema	object	JsonSchema representation of this actions's input schema (id: JsonSchema)
inputParameters	array	List containing input parameter metadata.
metadata	object	Metadata like service latency, etc.
resultJsonSchema	object	JsonSchema representation of this actions's result schema (id: JsonSchema)
resultMetadata	array	List containing the metadata of result fields.

list

Successful response

Name	Datatype	Description
name	string	Name of the action.
description	string	Brief Description of action
displayName	string	Display Name of action to be shown on client side
inputJsonSchema	object	JsonSchema representation of this actions's input schema (id: JsonSchema)
inputParameters	array	List containing input parameter metadata.
metadata	object	Metadata like service latency, etc.
resultJsonSchema	object	JsonSchema representation of this actions's result schema (id: JsonSchema)
resultMetadata	array	List containing the metadata of result fields.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, connectionsId, actionsId	view	Gets the schema of the given action.
list	select	projectsId, locationsId, connectionsId	pageSize, pageToken, view	Gets the schema of all the actions supported by the connector.
execute	exec	projectsId, locationsId, connectionsId, actionsId		Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request.

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
actionsId	string
connectionsId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
view	string

SELECT examples

get

Gets the schema of the given action.

SELECT
name,
description,
displayName,
inputJsonSchema,
inputParameters,
metadata,
resultJsonSchema,
resultMetadata
FROM google.connectors.actions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND connectionsId = '{{ connectionsId }}' -- required
AND actionsId = '{{ actionsId }}' -- required
AND view = '{{ view }}';

list

Gets the schema of all the actions supported by the connector.

SELECT
name,
description,
displayName,
inputJsonSchema,
inputParameters,
metadata,
resultJsonSchema,
resultMetadata
FROM google.connectors.actions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND connectionsId = '{{ connectionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND view = '{{ view }}';

Lifecycle Methods

execute

Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request.

EXEC google.connectors.actions.execute 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@connectionsId='{{ connectionsId }}' --required, 
@actionsId='{{ actionsId }}' --required 
@@json=
'{
"parameters": "{{ parameters }}"
}';