Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

API hub v1 API - Class ApiHubPlugin.ApiHubPluginBase (1.2.0)

[BindServiceMethod(typeof(ApiHubPlugin), "BindService")]
public abstract class ApiHubPlugin.ApiHubPluginBase

Reference documentation and code samples for the API hub v1 API class ApiHubPlugin.ApiHubPluginBase.

Base class for server-side implementations of ApiHubPlugin

Inheritance

object > ApiHubPlugin.ApiHubPluginBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Methods

CreatePlugin(CreatePluginRequest, ServerCallContext)

public virtual Task<Plugin> CreatePlugin(CreatePluginRequest request, ServerCallContext context)

Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.

Parameters
Name	Description
`request`	`CreatePluginRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPlugin`	The response to send back to the client (wrapped by a task).

CreatePluginInstance(CreatePluginInstanceRequest, ServerCallContext)

public virtual Task<Operation> CreatePluginInstance(CreatePluginInstanceRequest request, ServerCallContext context)

Creates a Plugin instance in the API hub.

Parameters
Name	Description
`request`	`CreatePluginInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeletePlugin(DeletePluginRequest, ServerCallContext)

public virtual Task<Operation> DeletePlugin(DeletePluginRequest request, ServerCallContext context)

Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.

Parameters
Name	Description
`request`	`DeletePluginRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeletePluginInstance(DeletePluginInstanceRequest, ServerCallContext)

public virtual Task<Operation> DeletePluginInstance(DeletePluginInstanceRequest request, ServerCallContext context)

Deletes a plugin instance in the API hub.

Parameters
Name	Description
`request`	`DeletePluginInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DisablePlugin(DisablePluginRequest, ServerCallContext)

public virtual Task<Plugin> DisablePlugin(DisablePluginRequest request, ServerCallContext context)

Disables a plugin. The state of the plugin after disabling is DISABLED

Parameters
Name	Description
`request`	`DisablePluginRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPlugin`	The response to send back to the client (wrapped by a task).

DisablePluginInstanceAction(DisablePluginInstanceActionRequest, ServerCallContext)

public virtual Task<Operation> DisablePluginInstanceAction(DisablePluginInstanceActionRequest request, ServerCallContext context)

Disables a plugin instance in the API hub.

Parameters
Name	Description
`request`	`DisablePluginInstanceActionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

EnablePlugin(EnablePluginRequest, ServerCallContext)

public virtual Task<Plugin> EnablePlugin(EnablePluginRequest request, ServerCallContext context)

Enables a plugin. The state of the plugin after enabling is ENABLED

Parameters
Name	Description
`request`	`EnablePluginRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPlugin`	The response to send back to the client (wrapped by a task).

EnablePluginInstanceAction(EnablePluginInstanceActionRequest, ServerCallContext)

public virtual Task<Operation> EnablePluginInstanceAction(EnablePluginInstanceActionRequest request, ServerCallContext context)

Enables a plugin instance in the API hub.

Parameters
Name	Description
`request`	`EnablePluginInstanceActionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

ExecutePluginInstanceAction(ExecutePluginInstanceActionRequest, ServerCallContext)

public virtual Task<Operation> ExecutePluginInstanceAction(ExecutePluginInstanceActionRequest request, ServerCallContext context)

Executes a plugin instance in the API hub.

Parameters
Name	Description
`request`	`ExecutePluginInstanceActionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

GetPlugin(GetPluginRequest, ServerCallContext)

public virtual Task<Plugin> GetPlugin(GetPluginRequest request, ServerCallContext context)

Get an API Hub plugin.

Parameters
Name	Description
`request`	`GetPluginRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPlugin`	The response to send back to the client (wrapped by a task).

GetPluginInstance(GetPluginInstanceRequest, ServerCallContext)

public virtual Task<PluginInstance> GetPluginInstance(GetPluginInstanceRequest request, ServerCallContext context)

Get an API Hub plugin instance.

Parameters
Name	Description
`request`	`GetPluginInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPluginInstance`	The response to send back to the client (wrapped by a task).

ListPluginInstances(ListPluginInstancesRequest, ServerCallContext)

public virtual Task<ListPluginInstancesResponse> ListPluginInstances(ListPluginInstancesRequest request, ServerCallContext context)

List all the plugins in a given project and location. - can be used as wildcard value for {plugin_id}

Parameters
Name	Description
`request`	`ListPluginInstancesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListPluginInstancesResponse`	The response to send back to the client (wrapped by a task).

ListPlugins(ListPluginsRequest, ServerCallContext)

public virtual Task<ListPluginsResponse> ListPlugins(ListPluginsRequest request, ServerCallContext context)

List all the plugins in a given project and location.

Parameters
Name	Description
`request`	`ListPluginsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListPluginsResponse`	The response to send back to the client (wrapped by a task).

UpdatePluginInstance(UpdatePluginInstanceRequest, ServerCallContext)

public virtual Task<PluginInstance> UpdatePluginInstance(UpdatePluginInstanceRequest request, ServerCallContext context)

Updates a plugin instance in the API hub. The following fields in the [plugin_instance][google.cloud.apihub.v1.PluginInstance] can be updated currently:

[display_name][google.cloud.apihub.v1.PluginInstance.display_name]
[schedule_cron_expression][PluginInstance.actions.schedule_cron_expression]

The [update_mask][google.cloud.apihub.v1.UpdatePluginInstanceRequest.update_mask] should be used to specify the fields being updated.

To update the [auth_config][google.cloud.apihub.v1.PluginInstance.auth_config] and [additional_config][google.cloud.apihub.v1.PluginInstance.additional_config] of the plugin instance, use the [ApplyPluginInstanceConfig][google.cloud.apihub.v1.ApiHubPlugin.ApplyPluginInstanceConfig] method.

Parameters
Name	Description
`request`	`UpdatePluginInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPluginInstance`	The response to send back to the client (wrapped by a task).