Show / Hide Table of Contents

Class GoogleCloudApihubV1Plugin

A plugin resource in the API Hub.

Inheritance
object
GoogleCloudApihubV1Plugin
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.APIhub.v1.Data
Assembly: Google.Apis.APIhub.v1.dll
Syntax
public class GoogleCloudApihubV1Plugin : IDirectResponseSchema

Properties

ActionsConfig

Optional. The configuration of actions supported by the plugin.

Declaration
[JsonProperty("actionsConfig")]
public virtual IList<GoogleCloudApihubV1PluginActionConfig> ActionsConfig { get; set; }
Property Value
Type Description
IList<GoogleCloudApihubV1PluginActionConfig>

ConfigTemplate

Optional. The configuration template for the plugin.

Declaration
[JsonProperty("configTemplate")]
public virtual GoogleCloudApihubV1ConfigTemplate ConfigTemplate { get; set; }
Property Value
Type Description
GoogleCloudApihubV1ConfigTemplate

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp indicating when the plugin was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

Description

Optional. The plugin description. Max length is 2000 characters (Unicode code points).

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

DisplayName

Required. The display name of the plugin. Max length is 50 characters (Unicode code points).

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

Documentation

Optional. The documentation of the plugin, that explains how to set up and use the plugin.

Declaration
[JsonProperty("documentation")]
public virtual GoogleCloudApihubV1Documentation Documentation { get; set; }
Property Value
Type Description
GoogleCloudApihubV1Documentation

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("hostingService")]
public virtual GoogleCloudApihubV1HostingService HostingService { get; set; }
Property Value
Type Description
GoogleCloudApihubV1HostingService

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

OwnershipType

Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.

Declaration
[JsonProperty("ownershipType")]
public virtual string OwnershipType { get; set; }
Property Value
Type Description
string

PluginCategory

Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.

Declaration
[JsonProperty("pluginCategory")]
public virtual string PluginCategory { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Type

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.

Declaration
[JsonProperty("type")]
public virtual GoogleCloudApihubV1AttributeValues Type { get; set; }
Property Value
Type Description
GoogleCloudApihubV1AttributeValues

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

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

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX