API hub v1 API - Class PluginInstance (1.1.0) 

public sealed class PluginInstance : IMessage<PluginInstance>, IEquatable<PluginInstance>, IDeepCloneable<PluginInstance>, IBufferMessage, IMessage

Reference documentation and code samples for the API hub v1 API class PluginInstance.

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.

Inheritance

object > PluginInstance

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

PluginInstance()

public PluginInstance()

PluginInstance(PluginInstance)

public PluginInstance(PluginInstance other)
Parameter
Name Description
other PluginInstance

Properties

Actions

public RepeatedField<PluginInstanceAction> Actions { get; }

Required. The action status for the plugin instance.

Property Value
Type Description
RepeatedFieldPluginInstanceAction

AdditionalConfig

public MapField<string, ConfigVariable> AdditionalConfig { get; }

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.

Property Value
Type Description
MapFieldstringConfigVariable

AuthConfig

public AuthConfig AuthConfig { get; set; }

Optional. The authentication information for this plugin instance.

Property Value
Type Description
AuthConfig

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp indicating when the plugin instance was created.

Property Value
Type Description
Timestamp

DisplayName

public string DisplayName { get; set; }

Required. The display name for this plugin instance. Max length is 255 characters.

Property Value
Type Description
string

ErrorMessage

public string ErrorMessage { get; set; }

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.

Property Value
Type Description
string

Name

public string Name { get; set; }

Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

Property Value
Type Description
string

PluginInstanceName

public PluginInstanceName PluginInstanceName { get; set; }

PluginInstanceName-typed view over the Name resource name property.

Property Value
Type Description
PluginInstanceName

SourceProjectId

public string SourceProjectId { get; set; }

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.

Property Value
Type Description
string

State

public PluginInstance.Types.State State { get; set; }

Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).

Property Value
Type Description
PluginInstanceTypesState

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp indicating when the plugin instance was last updated.

Property Value
Type Description
Timestamp