Class PluginInstance (0.2.7)

PluginInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.

Attributes

Name Description
name str
Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
display_name str
Required. The display name for this plugin instance. Max length is 255 characters.
auth_config google.cloud.apihub_v1.types.AuthConfig
Optional. The authentication information for this plugin instance.
additional_config MutableMapping[str, google.cloud.apihub_v1.types.ConfigVariable]
Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.
state google.cloud.apihub_v1.types.PluginInstance.State
Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).
error_message str
Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.
actions MutableSequence[google.cloud.apihub_v1.types.PluginInstanceAction]
Required. The action status for the plugin instance.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp indicating when the plugin instance was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp indicating when the plugin instance was last updated.
source_project_id str
Optional. The source project id of the plugin instance. This will be the id of runtime project in case of gcp based plugins and org id in case of non gcp based plugins. This field will be a required field for Google provided on-ramp plugins.

Classes

AdditionalConfigEntry

AdditionalConfigEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

State represents the state of the plugin instance.