addons

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

Overview

Name	addons
Type	Resource
Id	google.apihub.addons

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The name of the addon to enable. Format: projects/{project}/locations/{location}/addons/{addon}.
config	object	Required. The configuration of the addon. (id: GoogleCloudApihubV1AddonConfig)
createTime	string (google-datetime)	Output only. The time at which the addon was created.
dataSource	string	Required. The data source on which the addon operates. This determines which field in the config oneof is used. (DATA_SOURCE_UNSPECIFIED, PLUGIN_INSTANCE, ALL_DATA)
description	string	Optional. The description of the addon.
displayName	string	Required. The display name of the addon.
state	string	Output only. The state of the addon. (ADDON_STATE_UNSPECIFIED, ACTIVE, UPDATING, ERROR, INACTIVE)
updateTime	string (google-datetime)	Output only. The time at which the addon was last updated.

list

Name	Datatype	Description
name	string	Identifier. The name of the addon to enable. Format: projects/{project}/locations/{location}/addons/{addon}.
config	object	Required. The configuration of the addon. (id: GoogleCloudApihubV1AddonConfig)
createTime	string (google-datetime)	Output only. The time at which the addon was created.
dataSource	string	Required. The data source on which the addon operates. This determines which field in the config oneof is used. (DATA_SOURCE_UNSPECIFIED, PLUGIN_INSTANCE, ALL_DATA)
description	string	Optional. The description of the addon.
displayName	string	Required. The display name of the addon.
state	string	Output only. The state of the addon. (ADDON_STATE_UNSPECIFIED, ACTIVE, UPDATING, ERROR, INACTIVE)
updateTime	string (google-datetime)	Output only. The time at which the addon was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, addonsId		Get an addon.
list	select	projectsId, locationsId	filter, pageSize, pageToken	List addons.
manage_config	exec	projectsId, locationsId, addonsId		Manage addon config. This RPC is used for managing the config of the addon. Calling this RPC moves the addon into an updating state until the long-running operation succeeds.

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
addonsId	string
locationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Get an addon.

SELECT
name,
config,
createTime,
dataSource,
description,
displayName,
state,
updateTime
FROM google.apihub.addons
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND addonsId = '{{ addonsId }}' -- required
;

list

List addons.

SELECT
name,
config,
createTime,
dataSource,
description,
displayName,
state,
updateTime
FROM google.apihub.addons
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

Lifecycle Methods

manage_config

Manage addon config. This RPC is used for managing the config of the addon. Calling this RPC moves the addon into an updating state until the long-running operation succeeds.

EXEC google.apihub.addons.manage_config 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@addonsId='{{ addonsId }}' --required 
@@json=
'{
"config": "{{ config }}"
}'
;