API hub v1 API - Class ApiHubPluginClientImpl (1.1.0) 

public sealed class ApiHubPluginClientImpl : ApiHubPluginClient

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

ApiHubPlugin client wrapper implementation, for convenient use.

Inheritance

object > ApiHubPluginClient > ApiHubPluginClientImpl

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Remarks

This service is used for managing plugins inside the API Hub.

Constructors

ApiHubPluginClientImpl(ApiHubPluginClient, ApiHubPluginSettings, ILogger)

public ApiHubPluginClientImpl(ApiHubPlugin.ApiHubPluginClient grpcClient, ApiHubPluginSettings settings, ILogger logger)

Constructs a client wrapper for the ApiHubPlugin service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ApiHubPluginApiHubPluginClient

The underlying gRPC client.
settings ApiHubPluginSettings

The base ApiHubPluginSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreatePluginInstanceOperationsClient

public override OperationsClient CreatePluginInstanceOperationsClient { get; }

The long-running operations client for CreatePluginInstance.

Property Value
Type Description
OperationsClient
Overrides

DeletePluginInstanceOperationsClient

public override OperationsClient DeletePluginInstanceOperationsClient { get; }

The long-running operations client for DeletePluginInstance.

Property Value
Type Description
OperationsClient
Overrides

DeletePluginOperationsClient

public override OperationsClient DeletePluginOperationsClient { get; }

The long-running operations client for DeletePlugin.

Property Value
Type Description
OperationsClient
Overrides

DisablePluginInstanceActionOperationsClient

public override OperationsClient DisablePluginInstanceActionOperationsClient { get; }

The long-running operations client for DisablePluginInstanceAction.

Property Value
Type Description
OperationsClient
Overrides

EnablePluginInstanceActionOperationsClient

public override OperationsClient EnablePluginInstanceActionOperationsClient { get; }

The long-running operations client for EnablePluginInstanceAction.

Property Value
Type Description
OperationsClient
Overrides

ExecutePluginInstanceActionOperationsClient

public override OperationsClient ExecutePluginInstanceActionOperationsClient { get; }

The long-running operations client for ExecutePluginInstanceAction.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override ApiHubPlugin.ApiHubPluginClient GrpcClient { get; }

The underlying gRPC ApiHubPlugin client

Property Value
Type Description
ApiHubPluginApiHubPluginClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

CreatePlugin(CreatePluginRequest, CallSettings)

public override Plugin CreatePlugin(CreatePluginRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Plugin

The RPC response.
Overrides

CreatePluginAsync(CreatePluginRequest, CallSettings)

public override Task<Plugin> CreatePluginAsync(CreatePluginRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPlugin

A Task containing the RPC response.
Overrides

CreatePluginInstance(CreatePluginInstanceRequest, CallSettings)

public override Operation<PluginInstance, OperationMetadata> CreatePluginInstance(CreatePluginInstanceRequest request, CallSettings callSettings = null)

Creates a Plugin instance in the API hub.

Parameters
Name Description
request CreatePluginInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationPluginInstanceOperationMetadata

The RPC response.
Overrides

CreatePluginInstanceAsync(CreatePluginInstanceRequest, CallSettings)

public override Task<Operation<PluginInstance, OperationMetadata>> CreatePluginInstanceAsync(CreatePluginInstanceRequest request, CallSettings callSettings = null)

Creates a Plugin instance in the API hub.

Parameters
Name Description
request CreatePluginInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationPluginInstanceOperationMetadata

A Task containing the RPC response.
Overrides

DeletePlugin(DeletePluginRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeletePlugin(DeletePluginRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeletePluginRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeletePluginAsync(DeletePluginRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeletePluginAsync(DeletePluginRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeletePluginRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeletePluginInstance(DeletePluginInstanceRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeletePluginInstance(DeletePluginInstanceRequest request, CallSettings callSettings = null)

Deletes a plugin instance in the API hub.

Parameters
Name Description
request DeletePluginInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeletePluginInstanceAsync(DeletePluginInstanceRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeletePluginInstanceAsync(DeletePluginInstanceRequest request, CallSettings callSettings = null)

Deletes a plugin instance in the API hub.

Parameters
Name Description
request DeletePluginInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DisablePlugin(DisablePluginRequest, CallSettings)

public override Plugin DisablePlugin(DisablePluginRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DisablePluginRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Plugin

The RPC response.
Overrides

DisablePluginAsync(DisablePluginRequest, CallSettings)

public override Task<Plugin> DisablePluginAsync(DisablePluginRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DisablePluginRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPlugin

A Task containing the RPC response.
Overrides

DisablePluginInstanceAction(DisablePluginInstanceActionRequest, CallSettings)

public override Operation<DisablePluginInstanceActionResponse, OperationMetadata> DisablePluginInstanceAction(DisablePluginInstanceActionRequest request, CallSettings callSettings = null)

Disables a plugin instance in the API hub.

Parameters
Name Description
request DisablePluginInstanceActionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationDisablePluginInstanceActionResponseOperationMetadata

The RPC response.
Overrides

DisablePluginInstanceActionAsync(DisablePluginInstanceActionRequest, CallSettings)

public override Task<Operation<DisablePluginInstanceActionResponse, OperationMetadata>> DisablePluginInstanceActionAsync(DisablePluginInstanceActionRequest request, CallSettings callSettings = null)

Disables a plugin instance in the API hub.

Parameters
Name Description
request DisablePluginInstanceActionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationDisablePluginInstanceActionResponseOperationMetadata

A Task containing the RPC response.
Overrides

EnablePlugin(EnablePluginRequest, CallSettings)

public override Plugin EnablePlugin(EnablePluginRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request EnablePluginRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Plugin

The RPC response.
Overrides

EnablePluginAsync(EnablePluginRequest, CallSettings)

public override Task<Plugin> EnablePluginAsync(EnablePluginRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request EnablePluginRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPlugin

A Task containing the RPC response.
Overrides

EnablePluginInstanceAction(EnablePluginInstanceActionRequest, CallSettings)

public override Operation<EnablePluginInstanceActionResponse, OperationMetadata> EnablePluginInstanceAction(EnablePluginInstanceActionRequest request, CallSettings callSettings = null)

Enables a plugin instance in the API hub.

Parameters
Name Description
request EnablePluginInstanceActionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEnablePluginInstanceActionResponseOperationMetadata

The RPC response.
Overrides

EnablePluginInstanceActionAsync(EnablePluginInstanceActionRequest, CallSettings)

public override Task<Operation<EnablePluginInstanceActionResponse, OperationMetadata>> EnablePluginInstanceActionAsync(EnablePluginInstanceActionRequest request, CallSettings callSettings = null)

Enables a plugin instance in the API hub.

Parameters
Name Description
request EnablePluginInstanceActionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEnablePluginInstanceActionResponseOperationMetadata

A Task containing the RPC response.
Overrides

ExecutePluginInstanceAction(ExecutePluginInstanceActionRequest, CallSettings)

public override Operation<ExecutePluginInstanceActionResponse, OperationMetadata> ExecutePluginInstanceAction(ExecutePluginInstanceActionRequest request, CallSettings callSettings = null)

Executes a plugin instance in the API hub.

Parameters
Name Description
request ExecutePluginInstanceActionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationExecutePluginInstanceActionResponseOperationMetadata

The RPC response.
Overrides

ExecutePluginInstanceActionAsync(ExecutePluginInstanceActionRequest, CallSettings)

public override Task<Operation<ExecutePluginInstanceActionResponse, OperationMetadata>> ExecutePluginInstanceActionAsync(ExecutePluginInstanceActionRequest request, CallSettings callSettings = null)

Executes a plugin instance in the API hub.

Parameters
Name Description
request ExecutePluginInstanceActionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationExecutePluginInstanceActionResponseOperationMetadata

A Task containing the RPC response.
Overrides

GetPlugin(GetPluginRequest, CallSettings)

public override Plugin GetPlugin(GetPluginRequest request, CallSettings callSettings = null)

Get an API Hub plugin.

Parameters
Name Description
request GetPluginRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Plugin

The RPC response.
Overrides

GetPluginAsync(GetPluginRequest, CallSettings)

public override Task<Plugin> GetPluginAsync(GetPluginRequest request, CallSettings callSettings = null)

Get an API Hub plugin.

Parameters
Name Description
request GetPluginRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPlugin

A Task containing the RPC response.
Overrides

GetPluginInstance(GetPluginInstanceRequest, CallSettings)

public override PluginInstance GetPluginInstance(GetPluginInstanceRequest request, CallSettings callSettings = null)

Get an API Hub plugin instance.

Parameters
Name Description
request GetPluginInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PluginInstance

The RPC response.
Overrides

GetPluginInstanceAsync(GetPluginInstanceRequest, CallSettings)

public override Task<PluginInstance> GetPluginInstanceAsync(GetPluginInstanceRequest request, CallSettings callSettings = null)

Get an API Hub plugin instance.

Parameters
Name Description
request GetPluginInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPluginInstance

A Task containing the RPC response.
Overrides

ListPluginInstances(ListPluginInstancesRequest, CallSettings)

public override PagedEnumerable<ListPluginInstancesResponse, PluginInstance> ListPluginInstances(ListPluginInstancesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListPluginInstancesResponsePluginInstance

A pageable sequence of PluginInstance resources.
Overrides

ListPluginInstancesAsync(ListPluginInstancesRequest, CallSettings)

public override PagedAsyncEnumerable<ListPluginInstancesResponse, PluginInstance> ListPluginInstancesAsync(ListPluginInstancesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListPluginInstancesResponsePluginInstance

A pageable asynchronous sequence of PluginInstance resources.
Overrides

ListPlugins(ListPluginsRequest, CallSettings)

public override PagedEnumerable<ListPluginsResponse, Plugin> ListPlugins(ListPluginsRequest request, CallSettings callSettings = null)

List all the plugins in a given project and location.

Parameters
Name Description
request ListPluginsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListPluginsResponsePlugin

A pageable sequence of Plugin resources.
Overrides

ListPluginsAsync(ListPluginsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPluginsResponse, Plugin> ListPluginsAsync(ListPluginsRequest request, CallSettings callSettings = null)

List all the plugins in a given project and location.

Parameters
Name Description
request ListPluginsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListPluginsResponsePlugin

A pageable asynchronous sequence of Plugin resources.
Overrides

UpdatePluginInstance(UpdatePluginInstanceRequest, CallSettings)

public override PluginInstance UpdatePluginInstance(UpdatePluginInstanceRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PluginInstance

The RPC response.
Overrides

UpdatePluginInstanceAsync(UpdatePluginInstanceRequest, CallSettings)

public override Task<PluginInstance> UpdatePluginInstanceAsync(UpdatePluginInstanceRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPluginInstance

A Task containing the RPC response.
Overrides