Plugin(mapping=None, *, ignore_unknown_fields=False, **kwargs)A plugin resource in the API Hub.
Attributes |
|
|---|---|
| Name | Description |
name |
str
Identifier. The name of the plugin. Format: projects/{project}/locations/{location}/plugins/{plugin}
|
display_name |
str
Required. The display name of the plugin. Max length is 50 characters (Unicode code points). |
type_ |
google.cloud.apihub_v1.types.AttributeValues
Optional. The type of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-plugin-type
attribute. The number of allowed values for this attribute
will be based on the cardinality of the attribute. The same
can be retrieved via GetAttribute API. All values should be
from the list of allowed values defined for the attribute.
Note this field is not required for plugins developed via
plugin framework.
|
description |
str
Optional. The plugin description. Max length is 2000 characters (Unicode code points). |
state |
google.cloud.apihub_v1.types.Plugin.State
Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level. |
ownership_type |
google.cloud.apihub_v1.types.Plugin.OwnershipType
Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'. |
hosting_service |
google.cloud.apihub_v1.types.Plugin.HostingService
Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI. |
actions_config |
MutableSequence[google.cloud.apihub_v1.types.PluginActionConfig]
Optional. The configuration of actions supported by the plugin. **REQUIRED**: This field must be provided when creating or updating a Plugin. The server will reject requests if this field is missing. |
documentation |
google.cloud.apihub_v1.types.Documentation
Optional. The documentation of the plugin, that explains how to set up and use the plugin. |
plugin_category |
google.cloud.apihub_v1.types.PluginCategory
Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins. |
config_template |
google.cloud.apihub_v1.types.Plugin.ConfigTemplate
Optional. The configuration template for the plugin. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp indicating when the plugin was created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp indicating when the plugin was last updated. |
gateway_type |
google.cloud.apihub_v1.types.GatewayType
Optional. The type of the gateway. |
Classes
ConfigTemplate
ConfigTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)ConfigTemplate represents the configuration template for a plugin.
HostingService
HostingService(mapping=None, *, ignore_unknown_fields=False, **kwargs)The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality.
OwnershipType
OwnershipType(value)Ownership type of the plugin.
State
State(value)Possible states a plugin can have. Note that this enum may receive new values in the future. Consumers are advised to always code against the enum values expecting new states can be added later on.