GoogleCloudApihubV1Plugin

import type { GoogleCloudApihubV1Plugin } from "https://googleapis.deno.dev/v1/apihub:v1.ts";

A plugin resource in the API Hub.

interface GoogleCloudApihubV1Plugin {

actionsConfig?: GoogleCloudApihubV1PluginActionConfig[];

configTemplate?: GoogleCloudApihubV1ConfigTemplate;

readonly createTime?: Date;

description?: string;

displayName?: string;

documentation?: GoogleCloudApihubV1Documentation;

hostingService?: GoogleCloudApihubV1HostingService;

name?: string;

readonly ownershipType?: "OWNERSHIP_TYPE_UNSPECIFIED" | "SYSTEM_OWNED" | "USER_OWNED";

pluginCategory?: "PLUGIN_CATEGORY_UNSPECIFIED" | "API_GATEWAY" | "API_PRODUCER";

readonly state?: "STATE_UNSPECIFIED" | "ENABLED" | "DISABLED";

type?: GoogleCloudApihubV1AttributeValues;

readonly updateTime?: Date;

}

§Properties

actionsConfig?: GoogleCloudApihubV1PluginActionConfig[]

[src]

Optional. The configuration of actions supported by the plugin.

configTemplate?: GoogleCloudApihubV1ConfigTemplate

[src]

Optional. The configuration template for the plugin.

readonly createTime?: Date

[src]

Output only. Timestamp indicating when the plugin was created.

description?: string

[src]

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

displayName?: string

[src]

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

documentation?: GoogleCloudApihubV1Documentation

[src]

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

hostingService?: GoogleCloudApihubV1HostingService

[src]

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?: string

[src]

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

readonly ownershipType?: "OWNERSHIP_TYPE_UNSPECIFIED" | "SYSTEM_OWNED" | "USER_OWNED"

[src]

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

pluginCategory?: "PLUGIN_CATEGORY_UNSPECIFIED" | "API_GATEWAY" | "API_PRODUCER"

[src]

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

readonly state?: "STATE_UNSPECIFIED" | "ENABLED" | "DISABLED"

[src]

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?: GoogleCloudApihubV1AttributeValues

[src]

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.

readonly updateTime?: Date

[src]

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