API hub V1 API - Class Google::Cloud::ApiHub::V1::PluginInstance (v0.6.0)

Reference documentation and code samples for the API hub V1 API class Google::Cloud::ApiHub::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#actions

def actions() -> ::Array<::Google::Cloud::ApiHub::V1::PluginInstanceAction>
Returns

#actions=

def actions=(value) -> ::Array<::Google::Cloud::ApiHub::V1::PluginInstanceAction>
Parameter
Returns

#additional_config

def additional_config() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::ConfigVariable}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::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.

#additional_config=

def additional_config=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::ConfigVariable}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::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.
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::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.

#auth_config

def auth_config() -> ::Google::Cloud::ApiHub::V1::AuthConfig
Returns

#auth_config=

def auth_config=(value) -> ::Google::Cloud::ApiHub::V1::AuthConfig
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The display name for this plugin instance. Max length is 255 characters.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The display name for this plugin instance. Max length is 255 characters.
Returns
  • (::String) — Required. The display name for this plugin instance. Max length is 255 characters.

#error_message

def error_message() -> ::String
Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
Returns
  • (::String) — Identifier. The unique name of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

#source_project_id

def source_project_id() -> ::String
Returns
  • (::String) — 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.

#source_project_id=

def source_project_id=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#state

def state() -> ::Google::Cloud::ApiHub::V1::PluginInstance::State
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns