API hub v1 API - Class ApiHubPlugin.ApiHubPluginClient (1.0.0-beta02)

public class ApiHubPlugin.ApiHubPluginClient : ClientBase<ApiHubPlugin.ApiHubPluginClient>

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

Client for ApiHubPlugin

Inheritance

object > ClientBase > ClientBaseApiHubPluginApiHubPluginClient > ApiHubPlugin.ApiHubPluginClient

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

ApiHubPluginClient()

protected ApiHubPluginClient()

Protected parameterless constructor to allow creation of test doubles.

ApiHubPluginClient(CallInvoker)

public ApiHubPluginClient(CallInvoker callInvoker)

Creates a new client for ApiHubPlugin that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

ApiHubPluginClient(ChannelBase)

public ApiHubPluginClient(ChannelBase channel)

Creates a new client for ApiHubPlugin

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

ApiHubPluginClient(ClientBaseConfiguration)

protected ApiHubPluginClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

DisablePlugin(DisablePluginRequest, CallOptions)

public virtual Plugin DisablePlugin(DisablePluginRequest request, CallOptions options)

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

Parameters
Name Description
request DisablePluginRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Plugin

The response received from the server.

DisablePlugin(DisablePluginRequest, Metadata, DateTime?, CancellationToken)

public virtual Plugin DisablePlugin(DisablePluginRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request DisablePluginRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Plugin

The response received from the server.

DisablePluginAsync(DisablePluginRequest, CallOptions)

public virtual AsyncUnaryCall<Plugin> DisablePluginAsync(DisablePluginRequest request, CallOptions options)

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

Parameters
Name Description
request DisablePluginRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPlugin

The call object.

DisablePluginAsync(DisablePluginRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Plugin> DisablePluginAsync(DisablePluginRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request DisablePluginRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallPlugin

The call object.

EnablePlugin(EnablePluginRequest, CallOptions)

public virtual Plugin EnablePlugin(EnablePluginRequest request, CallOptions options)

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

Parameters
Name Description
request EnablePluginRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Plugin

The response received from the server.

EnablePlugin(EnablePluginRequest, Metadata, DateTime?, CancellationToken)

public virtual Plugin EnablePlugin(EnablePluginRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request EnablePluginRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Plugin

The response received from the server.

EnablePluginAsync(EnablePluginRequest, CallOptions)

public virtual AsyncUnaryCall<Plugin> EnablePluginAsync(EnablePluginRequest request, CallOptions options)

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

Parameters
Name Description
request EnablePluginRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPlugin

The call object.

EnablePluginAsync(EnablePluginRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Plugin> EnablePluginAsync(EnablePluginRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request EnablePluginRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallPlugin

The call object.

GetPlugin(GetPluginRequest, CallOptions)

public virtual Plugin GetPlugin(GetPluginRequest request, CallOptions options)

Get details about an API Hub plugin.

Parameters
Name Description
request GetPluginRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Plugin

The response received from the server.

GetPlugin(GetPluginRequest, Metadata, DateTime?, CancellationToken)

public virtual Plugin GetPlugin(GetPluginRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get details about an API Hub plugin.

Parameters
Name Description
request GetPluginRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Plugin

The response received from the server.

GetPluginAsync(GetPluginRequest, CallOptions)

public virtual AsyncUnaryCall<Plugin> GetPluginAsync(GetPluginRequest request, CallOptions options)

Get details about an API Hub plugin.

Parameters
Name Description
request GetPluginRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPlugin

The call object.

GetPluginAsync(GetPluginRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Plugin> GetPluginAsync(GetPluginRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get details about an API Hub plugin.

Parameters
Name Description
request GetPluginRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallPlugin

The call object.

NewInstance(ClientBaseConfiguration)

protected override ApiHubPlugin.ApiHubPluginClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
ApiHubPluginApiHubPluginClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.ApiHub.V1.ApiHubPlugin.ApiHubPluginClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)