REST Resource: projects.locations.plugins.instances

Resource: 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.

JSON representation 
{
  "name": string,
  "displayName": string,
  "authConfig": {
    object (AuthConfig)
  },
  "additionalConfig": {
    string: {
      object (ConfigVariable)
    },
    ...
  },
  "state": enum (State),
  "errorMessage": string,
  "actions": [
    {
      object (PluginInstanceAction)
    }
  ],
  "createTime": string,
  "updateTime": string
}
Fields
name

string

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

string

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

object (AuthConfig)

Optional. The authentication information for this plugin instance.
additionalConfig

map (key: string, value: object (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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

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

string

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[]

object (PluginInstanceAction)

Required. The action status for the plugin instance.
createTime

string (Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

AuthConfig

AuthConfig represents the authentication information.

JSON representation 
{
  "authType": enum (AuthType),

  // Union field config can be only one of the following:
  "googleServiceAccountConfig": {
    object (GoogleServiceAccountConfig)
  },
  "userPasswordConfig": {
    object (UserPasswordConfig)
  },
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauth2ClientCredentialsConfig": {
    object (Oauth2ClientCredentialsConfig)
  }
  // End of list of possible types for union field config.
}
Fields
authType

enum (AuthType)

Required. The authentication type.
Union field config. Supported auth types. config can be only one of the following:
googleServiceAccountConfig

object (GoogleServiceAccountConfig)

Google Service Account.
userPasswordConfig

object (UserPasswordConfig)

User Password.
apiKeyConfig

object (ApiKeyConfig)

Api Key Config.
oauth2ClientCredentialsConfig

object (Oauth2ClientCredentialsConfig)

Oauth2.0 Client Credentials.

UserPasswordConfig

Parameters to support Username and Password Authentication.

JSON representation 
{
  "username": string,
  "password": {
    object (Secret)
  }
}
Fields
username

string

Required. Username.
password

object (Secret)

Required. Secret version reference containing the password. The secretmanager.versions.access permission should be granted to the service account accessing the secret.

Secret

Secret provides a reference to entries in Secret Manager.

JSON representation 
{
  "secretVersion": string
}
Fields
secretVersion

string

Required. The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.

ApiKeyConfig

Config for authentication with API key.

JSON representation 
{
  "name": string,
  "apiKey": {
    object (Secret)
  },
  "httpElementLocation": enum (HttpElementLocation)
}
Fields
name

string

Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?apiKey=", "apiKey" would be the parameter name.
apiKey

object (Secret)

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}. The secretmanager.versions.access permission should be granted to the service account accessing the secret.
httpElementLocation

enum (HttpElementLocation)

Required. The location of the API key. The default value is QUERY.

HttpElementLocation

Enum of location an HTTP element can be.

Enums
HTTP_ELEMENT_LOCATION_UNSPECIFIED HTTP element location not specified.
QUERY Element is in the HTTP request query.
HEADER Element is in the HTTP request header.
PATH Element is in the HTTP request path.
BODY Element is in the HTTP request body.
COOKIE Element is in the HTTP request cookie.

Oauth2ClientCredentialsConfig

Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.

JSON representation 
{
  "clientId": string,
  "clientSecret": {
    object (Secret)
  }
}
Fields
clientId

string

Required. The client identifier.
clientSecret

object (Secret)

Required. Secret version reference containing the client secret. The secretmanager.versions.access permission should be granted to the service account accessing the secret.

ConfigVariable

ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.

JSON representation 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "intValue": string,
  "boolValue": boolean,
  "secretValue": {
    object (Secret)
  },
  "enumValue": {
    object (ConfigValueOption)
  },
  "multiSelectValues": {
    object (MultiSelectValues)
  },
  "multiStringValues": {
    object (MultiStringValues)
  },
  "multiIntValues": {
    object (MultiIntValues)
  }
  // End of list of possible types for union field value.
}
Fields
key

string

Output only. Key will be the id to uniquely identify the config variable.
Union field value. The values associated with the config variable. value can be only one of the following:
stringValue

string

Optional. The config variable value in case of config variable of type string.
intValue

string (int64 format)

Optional. The config variable value in case of config variable of type integer.
boolValue

boolean

Optional. The config variable value in case of config variable of type boolean.
secretValue

object (Secret)

Optional. The config variable value in case of config variable of type secret.
enumValue

object (ConfigValueOption)

Optional. The config variable value in case of config variable of type enum.
multiSelectValues

object (MultiSelectValues)

Optional. The config variable value in case of config variable of type multi select.
multiStringValues

object (MultiStringValues)

Optional. The config variable value in case of config variable of type multi string.
multiIntValues

object (MultiIntValues)

Optional. The config variable value in case of config variable of type multi integer.

MultiSelectValues

The config variable value of data type multi select.

JSON representation 
{
  "values": [
    {
      object (ConfigValueOption)
    }
  ]
}
Fields
values[]

object (ConfigValueOption)

Optional. The config variable value of data type multi select.

MultiStringValues

The config variable value of data type multi string.

JSON representation 
{
  "values": [
    string
  ]
}
Fields
values[]

string

Optional. The config variable value of data type multi string.

MultiIntValues

The config variable value of data type multi int.

JSON representation 
{
  "values": [
    integer
  ]
}
Fields
values[]

integer

Optional. The config variable value of data type multi int.

State

State represents the state of the plugin instance.

Enums
STATE_UNSPECIFIED Default unspecified state.
CREATING The plugin instance is being created.
ACTIVE The plugin instance is active and ready for executions. This is the only state where executions can run on the plugin instance.
APPLYING_CONFIG The updated config that contains additionalConfig and authConfig is being applied.
ERROR The ERROR state can come while applying config. Users can retrigger instances.applyConfig to restore the plugin instance back to active state. Note, In case the ERROR state happens while applying config (authConfig, additionalConfig), the plugin instance will reflect the config which was trying to be applied while error happened. In order to overwrite, trigger ApplyConfig with a new config.
FAILED The plugin instance is in a failed state. This indicates that an unrecoverable error occurred during a previous operation (Create, Delete).
DELETING The plugin instance is being deleted. Delete is only possible if there is no other operation running on the plugin instance and plugin instance action.

PluginInstanceAction

PluginInstanceAction represents an action which can be executed in the plugin instance.

JSON representation 
{
  "actionId": string,
  "state": enum (State),
  "scheduleCronExpression": string,
  "curationConfig": {
    object (CurationConfig)
  },
  "scheduleTimeZone": string,

  // Union field action_status can be only one of the following:
  "hubInstanceAction": {
    object (ExecutionStatus)
  }
  // End of list of possible types for union field action_status.
}
Fields
actionId

string

Required. This should map to one of the action id specified in actionsConfig in the plugin.
state

enum (State)

Output only. The current state of the plugin action in the plugin instance.
scheduleCronExpression

string

Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
curationConfig

object (CurationConfig)

Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
scheduleTimeZone

string

Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
Union field action_status. The status of the plugin action. action_status can be only one of the following:
hubInstanceAction

object (ExecutionStatus)

Optional. The execution information for the plugin instance action done corresponding to an API hub instance.

ExecutionStatus

The execution status for the plugin instance.

JSON representation 
{
  "currentExecutionState": enum (CurrentExecutionState),
  "lastExecution": {
    object (LastExecution)
  }
}
Fields
currentExecutionState

enum (CurrentExecutionState)

Output only. The current state of the execution.
lastExecution

object (LastExecution)

Output only. The last execution of the plugin instance.

CurrentExecutionState

Enum for the current state of the execution.

Enums
CURRENT_EXECUTION_STATE_UNSPECIFIED Default unspecified execution state.
RUNNING The plugin instance is executing.
NOT_RUNNING The plugin instance is not running an execution.

LastExecution

The result of the last execution of the plugin instance.

JSON representation 
{
  "result": enum (Result),
  "errorMessage": string,
  "startTime": string,
  "endTime": string
}
Fields
result

enum (Result)

Output only. The result of the last execution of the plugin instance.
errorMessage

string

Output only. Error message describing the failure, if any, during the last execution.
startTime

string (Timestamp format)

Output only. The last execution start time of the plugin instance.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Output only. The last execution end time of the plugin instance.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Result

Enum for the result of the last execution of the plugin instance.

Enums
RESULT_UNSPECIFIED Default unspecified execution result.
SUCCEEDED The plugin instance executed successfully.
FAILED The plugin instance execution failed.

State

State represents the state of the plugin instance action.

Enums
STATE_UNSPECIFIED Default unspecified state.
ENABLED The action is enabled in the plugin instance i.e., executions can be triggered for this action.
DISABLED The action is disabled in the plugin instance i.e., no executions can be triggered for this action. This state indicates that the user explicitly disabled the instance, and no further action is needed unless the user wants to re-enable it.
ENABLING The action in the plugin instance is being enabled.
DISABLING The action in the plugin instance is being disabled.
ERROR The ERROR state can come while enabling/disabling plugin instance action. Users can retrigger enable, disable via instances.enableAction and instances.disableAction to restore the action back to enabled/disabled state. Note enable/disable on actions can only be triggered if plugin instance is in Active state.

CurationConfig

The curation information for this plugin instance.

JSON representation 
{
  "curationType": enum (CurationType),

  // Union field curation_config can be only one of the following:
  "customCuration": {
    object (CustomCuration)
  }
  // End of list of possible types for union field curation_config.
}
Fields
curationType

enum (CurationType)

Required. The curation type for this plugin instance.
Union field curation_config. The curation information for this plugin instance. curation_config can be only one of the following:
customCuration

object (CustomCuration)

Optional. Custom curation information for this plugin instance.

CustomCuration

Custom curation information for this plugin instance.

JSON representation 
{
  "curation": string
}
Fields
curation

string

Required. The unique name of the curation resource. This will be the name of the curation resource in the format: projects/{project}/locations/{location}/curations/{curation}

CurationType

Enum for the curation type.

Enums
CURATION_TYPE_UNSPECIFIED Default unspecified curation type.
DEFAULT_CURATION_FOR_API_METADATA Default curation for API metadata will be used.
CUSTOM_CURATION_FOR_API_METADATA Custom curation for API metadata will be used.

Methods

create

 Creates a Plugin instance in the API hub.

delete

 Deletes a plugin instance in the API hub.

disableAction

 Disables a plugin instance in the API hub.

enableAction

 Enables a plugin instance in the API hub.

executeAction

 Executes a plugin instance in the API hub.

get

 Get an API hub plugin instance.

list

 List all the plugins in a given project and location.