Console
    Start free

    REST Resource: projects.locations.addons

    Resource: Addon

    Addon resource.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "dataSource" 
 : 
 enum (  DataSource 
 
) 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "config" 
 : 
 { 
 object (  AddonConfig 
 
) 
 } 
 , 
 "state" 
 : 
 enum (  AddonState 
 
) 
 }
    Fields
    name

    string

    Identifier. The name of the addon to enable. Format: projects/{project}/locations/{location}/addons/{addon} .
    displayName

    string

    Required. The display name of the addon.
    description

    string

    Optional. The description of the addon.
    dataSource

    enum ( DataSource )

    Required. The data source on which the addon operates. This determines which field in the config oneof is used.
    createTime

    string ( Timestamp format)

    Output only. The time at which the addon was created.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    updateTime

    string ( Timestamp format)

    Output only. The time at which the addon was last updated.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    config

    object ( AddonConfig )

    Required. The configuration of the addon.
    state

    enum ( AddonState )

    Output only. The state of the addon.

    DataSource

    The data source on which the addon operates.

    Enums
    DATA_SOURCE_UNSPECIFIED The data source of the addon is not specified.
    PLUGIN_INSTANCE Addon operates on data collected from specific plugin instances.
    ALL_DATA Addon operates on all data in the API hub.

    AddonConfig

    Configuration for the addon.

    JSON representation 
     { 
 // Union field config 
can be only one of the following: 
 "gatewayPluginAddonConfig" 
 : 
 { 
 object (  GatewayPluginAddonConfig 
 
) 
 } 
 , 
 "allDataAddonConfig" 
 : 
 { 
 object (  AllDataAddonConfig 
 
) 
 } 
 // End of list of possible types for union field config 
. 
 }
    Fields
    Union field config . Addon configuration, which varies based on the data_source. Keeping this as a oneof in case we want to add configuration for other data sources in the future. config can be only one of the following:
    gatewayPluginAddonConfig

    object ( GatewayPluginAddonConfig )

    Configuration for gateway plugin addons.

    allDataAddonConfig

    object ( AllDataAddonConfig )

    Configuration for addons which act on all data in the API hub.

    GatewayPluginAddonConfig

    Configuration for gateway plugin addons. This is used to specify the list of gateway plugin configs for which the addon is enabled.

    JSON representation 
     { 
 "gatewayPluginConfigs" 
 : 
 [ 
 { 
 object (  GatewayPluginConfig 
 
) 
 } 
 ] 
 }
    Fields
    gatewayPluginConfigs[]

    object ( GatewayPluginConfig )

    Required. The list of gateway plugin configs for which the addon is enabled. Each gateway plugin config should have a unique plugin instance.

    GatewayPluginConfig

    Configuration for a gateway plugin. This is used to specify configs for different gateways.

    JSON representation 
     { 
 "pluginInstance" 
 : 
 string 
 , 
 // Union field config 
can be only one of the following: 
 "apigeeXHybridConfig" 
 : 
 { 
 object (  ApigeeXHybridConfig 
 
) 
 } 
 , 
 "apigeeEdgeConfig" 
 : 
 { 
 object (  ApigeeEdgeConfig 
 
) 
 } 
 , 
 "apigeeOpdkConfig" 
 : 
 { 
 object (  ApigeeOPDKConfig 
 
) 
 } 
 // End of list of possible types for union field config 
. 
 }
    Fields
    pluginInstance

    string

    Required. The name of the gateway plugin instance for which the config is to be specified. Format: projects/{project}/locations/{location}/plugins/{plugin}/pluginInstances/{pluginInstance}

    Union field config . The config of the gateway plugin. config can be only one of the following:
    apigeeXHybridConfig

    object ( ApigeeXHybridConfig )

    Configuration for Apigee X and Apigee Hybrid gateways.

    apigeeEdgeConfig

    object ( ApigeeEdgeConfig )

    Configuration for Apigee Edge gateways.

    apigeeOpdkConfig

    object ( ApigeeOPDKConfig )

    Configuration for Apigee OPDK gateways.

    ApigeeXHybridConfig

    Configuration for Apigee X and Apigee Hybrid gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance.

    JSON representation 
     { 
 "environmentFilter" 
 : 
 { 
 object (  EnvironmentFilter 
 
) 
 } 
 }
    Fields
    environmentFilter

    object ( EnvironmentFilter )

    Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.

    EnvironmentFilter

    Filter for environments.

    JSON representation 
     { 
 "allEnvironments" 
 : 
 boolean 
 , 
 "environments" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    allEnvironments

    boolean

    Optional. Indicates if this filter should match all environments or only a subset of environments. If set to true, all environments are matched.
    environments[]

    string

    Optional. If provided, only environments in this list are matched. This field is ignored if allEnvironments is true.

    ApigeeEdgeConfig

    Configuration for Apigee Edge gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance.

    JSON representation 
     { 
 "environmentFilter" 
 : 
 { 
 object (  EnvironmentFilter 
 
) 
 } 
 }
    Fields
    environmentFilter

    object ( EnvironmentFilter )

    Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.

    ApigeeOPDKConfig

    Configuration for Apigee OPDK gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance.

    JSON representation 
     { 
 "environmentFilter" 
 : 
 { 
 object (  EnvironmentFilter 
 
) 
 } 
 }
    Fields
    environmentFilter

    object ( EnvironmentFilter )

    Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.

    AllDataAddonConfig

    Configuration for addons which act on all data in the API hub. This is used to specify if the addon is enabled for all data in the API hub.

    JSON representation 
     { 
 "enabled" 
 : 
 boolean 
 }
    Fields
    enabled

    boolean

    Required. If true, the addon is enabled for all data in the API hub.

    AddonState

    The state of the addon.

    Enums
    ADDON_STATE_UNSPECIFIED The addon state is not specified.
    ACTIVE The addon is active.
    UPDATING The addon is being updated.
    ERROR The addon is in error state.
    INACTIVE The addon is inactive.

    Methods

    get

    		Get an addon.

    list

    		List addons.

    manageConfig

    		Manage addon config.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: