Reference documentation and code samples for the API hub V1 API class Google::Cloud::ApiHub::V1::Plugin.
A plugin resource in the API Hub.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#actions_config
def actions_config() -> ::Array<::Google::Cloud::ApiHub::V1::PluginActionConfig>
Returns
- (::Array<::Google::Cloud::ApiHub::V1::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.
#actions_config=
def actions_config=(value) -> ::Array<::Google::Cloud::ApiHub::V1::PluginActionConfig>
Parameter
- value (::Array<::Google::Cloud::ApiHub::V1::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.
Returns
- (::Array<::Google::Cloud::ApiHub::V1::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.
#config_template
def config_template() -> ::Google::Cloud::ApiHub::V1::Plugin::ConfigTemplate
Returns
- (::Google::Cloud::ApiHub::V1::Plugin::ConfigTemplate) — Optional. The configuration template for the plugin.
#config_template=
def config_template=(value) -> ::Google::Cloud::ApiHub::V1::Plugin::ConfigTemplate
Parameter
- value (::Google::Cloud::ApiHub::V1::Plugin::ConfigTemplate) — Optional. The configuration template for the plugin.
Returns
- (::Google::Cloud::ApiHub::V1::Plugin::ConfigTemplate) — Optional. The configuration template for the plugin.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp indicating when the plugin was created.
#description
def description() -> ::String
Returns
- (::String) — Optional. The plugin description. Max length is 2000 characters (Unicode code points).
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. The plugin description. Max length is 2000 characters (Unicode code points).
Returns
- (::String) — Optional. The plugin description. Max length is 2000 characters (Unicode code points).
#display_name
def display_name() -> ::String
Returns
- (::String) — Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
Returns
- (::String) — Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
#documentation
def documentation() -> ::Google::Cloud::ApiHub::V1::Documentation
Returns
- (::Google::Cloud::ApiHub::V1::Documentation) — Optional. The documentation of the plugin, that explains how to set up and use the plugin.
#documentation=
def documentation=(value) -> ::Google::Cloud::ApiHub::V1::Documentation
Parameter
- value (::Google::Cloud::ApiHub::V1::Documentation) — Optional. The documentation of the plugin, that explains how to set up and use the plugin.
Returns
- (::Google::Cloud::ApiHub::V1::Documentation) — Optional. The documentation of the plugin, that explains how to set up and use the plugin.
#gateway_type
def gateway_type() -> ::Google::Cloud::ApiHub::V1::GatewayType
Returns
- (::Google::Cloud::ApiHub::V1::GatewayType) — Optional. The type of the gateway.
#gateway_type=
def gateway_type=(value) -> ::Google::Cloud::ApiHub::V1::GatewayType
Parameter
- value (::Google::Cloud::ApiHub::V1::GatewayType) — Optional. The type of the gateway.
Returns
- (::Google::Cloud::ApiHub::V1::GatewayType) — Optional. The type of the gateway.
#hosting_service
def hosting_service() -> ::Google::Cloud::ApiHub::V1::Plugin::HostingService
Returns
-
(::Google::Cloud::ApiHub::V1::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.
#hosting_service=
def hosting_service=(value) -> ::Google::Cloud::ApiHub::V1::Plugin::HostingService
Parameter
-
value (::Google::Cloud::ApiHub::V1::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.
Returns
-
(::Google::Cloud::ApiHub::V1::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.
#name
def name() -> ::String
Returns
-
(::String) — Identifier. The name of the plugin.
Format:
projects/{project}/locations/{location}/plugins/{plugin}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Identifier. The name of the plugin.
Format:
projects/{project}/locations/{location}/plugins/{plugin}
Returns
-
(::String) — Identifier. The name of the plugin.
Format:
projects/{project}/locations/{location}/plugins/{plugin}
#ownership_type
def ownership_type() -> ::Google::Cloud::ApiHub::V1::Plugin::OwnershipType
Returns
- (::Google::Cloud::ApiHub::V1::Plugin::OwnershipType) — Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.
#plugin_category
def plugin_category() -> ::Google::Cloud::ApiHub::V1::PluginCategory
Returns
- (::Google::Cloud::ApiHub::V1::PluginCategory) — Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.
#plugin_category=
def plugin_category=(value) -> ::Google::Cloud::ApiHub::V1::PluginCategory
Parameter
- value (::Google::Cloud::ApiHub::V1::PluginCategory) — Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.
Returns
- (::Google::Cloud::ApiHub::V1::PluginCategory) — Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.
#state
def state() -> ::Google::Cloud::ApiHub::V1::Plugin::State
Returns
- (::Google::Cloud::ApiHub::V1::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.
#type
def type() -> ::Google::Cloud::ApiHub::V1::AttributeValues
Returns
-
(::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The type of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-plugin-typeattribute. 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.
#type=
def type=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
Parameter
-
value (::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The type of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-plugin-typeattribute. 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.
Returns
-
(::Google::Cloud::ApiHub::V1::AttributeValues) — Optional. The type of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-plugin-typeattribute. 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.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp indicating when the plugin was last updated.