Connect Gateway v1 API - Class GatewayControl.GatewayControlClient (1.0.0-beta02)

public class GatewayControl.GatewayControlClient : ClientBase<GatewayControl.GatewayControlClient>

Reference documentation and code samples for the Connect Gateway v1 API class GatewayControl.GatewayControlClient.

Client for GatewayControl

Inheritance

object > ClientBase > ClientBaseGatewayControlGatewayControlClient > GatewayControl.GatewayControlClient

Namespace

Google.Cloud.GkeConnect.Gateway.V1

Assembly

Google.Cloud.GkeConnect.Gateway.V1.dll

Constructors

GatewayControlClient()

protected GatewayControlClient()

Protected parameterless constructor to allow creation of test doubles.

GatewayControlClient(CallInvoker)

public GatewayControlClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

GatewayControlClient(ChannelBase)

public GatewayControlClient(ChannelBase channel)

Creates a new client for GatewayControl

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

GatewayControlClient(ClientBaseConfiguration)

protected GatewayControlClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

GenerateCredentials(GenerateCredentialsRequest, CallOptions)

public virtual GenerateCredentialsResponse GenerateCredentials(GenerateCredentialsRequest request, CallOptions options)

GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.

Parameters
Name Description
request GenerateCredentialsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
GenerateCredentialsResponse

The response received from the server.

GenerateCredentials(GenerateCredentialsRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateCredentialsResponse GenerateCredentials(GenerateCredentialsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.

Parameters
Name Description
request GenerateCredentialsRequest

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
GenerateCredentialsResponse

The response received from the server.

GenerateCredentialsAsync(GenerateCredentialsRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateCredentialsResponse> GenerateCredentialsAsync(GenerateCredentialsRequest request, CallOptions options)

GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.

Parameters
Name Description
request GenerateCredentialsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallGenerateCredentialsResponse

The call object.

GenerateCredentialsAsync(GenerateCredentialsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateCredentialsResponse> GenerateCredentialsAsync(GenerateCredentialsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.

Parameters
Name Description
request GenerateCredentialsRequest

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
AsyncUnaryCallGenerateCredentialsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override GatewayControl.GatewayControlClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
GatewayControlGatewayControlClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.GkeConnect.Gateway.V1.GatewayControl.GatewayControlClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)