REST Resource: projects.locations.plugins

Resource: Plugin

A plugin resource in the API Hub.

JSON representation
{
  "name": string,
  "displayName": string,
  "type": {
    object (AttributeValues)
  },
  "description": string,
  "state": enum (State)
}
Fields
name

string

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

displayName

string

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

type

object (AttributeValues)

Required. 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.

description

string

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

state

enum (State)

Output only. Represents the state of the plugin.

State

Possible states a plugin can have. Note that this enum may receive new values in the future. Consumers are advised to always code against the enum values expecting new states can be added later on.

Enums
STATE_UNSPECIFIED The default value. This value is used if the state is omitted.
ENABLED The plugin is enabled.
DISABLED The plugin is disabled.

Methods

disable

Disables a plugin.

enable

Enables a plugin.

get

Get details about an API Hub plugin.

getStyleGuide

Get the style guide being used for linting.

updateStyleGuide

Update the styleGuide to be used for liniting in by API hub.