API Gateway v1 API - Class ApiGatewayService.ApiGatewayServiceClient (2.1.0)

public class ApiGatewayServiceClient : ClientBase<ApiGatewayService.ApiGatewayServiceClient>

Reference documentation and code samples for the API Gateway v1 API class ApiGatewayService.ApiGatewayServiceClient.

Client for ApiGatewayService

Inheritance

Object > ClientBase > ClientBase<ApiGatewayService.ApiGatewayServiceClient> > ApiGatewayService.ApiGatewayServiceClient

Namespace

Google.Cloud.ApiGateway.V1

Assembly

Google.Cloud.ApiGateway.V1.dll

Constructors

ApiGatewayServiceClient()

protected ApiGatewayServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ApiGatewayServiceClient(CallInvoker)

public ApiGatewayServiceClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

ApiGatewayServiceClient(ChannelBase)

public ApiGatewayServiceClient(ChannelBase channel)

Creates a new client for ApiGatewayService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ApiGatewayServiceClient(ClientBase.ClientBaseConfiguration)

protected ApiGatewayServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateApi(CreateApiRequest, CallOptions)

public virtual Operation CreateApi(CreateApiRequest request, CallOptions options)

Creates a new Api in a given project and location.

Parameters
NameDescription
requestCreateApiRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateApi(CreateApiRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateApi(CreateApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new Api in a given project and location.

Parameters
NameDescription
requestCreateApiRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateApiAsync(CreateApiRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateApiAsync(CreateApiRequest request, CallOptions options)

Creates a new Api in a given project and location.

Parameters
NameDescription
requestCreateApiRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateApiAsync(CreateApiRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateApiAsync(CreateApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new Api in a given project and location.

Parameters
NameDescription
requestCreateApiRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateApiConfig(CreateApiConfigRequest, CallOptions)

public virtual Operation CreateApiConfig(CreateApiConfigRequest request, CallOptions options)

Creates a new ApiConfig in a given project and location.

Parameters
NameDescription
requestCreateApiConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateApiConfig(CreateApiConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateApiConfig(CreateApiConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new ApiConfig in a given project and location.

Parameters
NameDescription
requestCreateApiConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateApiConfigAsync(CreateApiConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateApiConfigAsync(CreateApiConfigRequest request, CallOptions options)

Creates a new ApiConfig in a given project and location.

Parameters
NameDescription
requestCreateApiConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateApiConfigAsync(CreateApiConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateApiConfigAsync(CreateApiConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new ApiConfig in a given project and location.

Parameters
NameDescription
requestCreateApiConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateGateway(CreateGatewayRequest, CallOptions)

public virtual Operation CreateGateway(CreateGatewayRequest request, CallOptions options)

Creates a new Gateway in a given project and location.

Parameters
NameDescription
requestCreateGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateGateway(CreateGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateGateway(CreateGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new Gateway in a given project and location.

Parameters
NameDescription
requestCreateGatewayRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateGatewayAsync(CreateGatewayRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateGatewayAsync(CreateGatewayRequest request, CallOptions options)

Creates a new Gateway in a given project and location.

Parameters
NameDescription
requestCreateGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateGatewayAsync(CreateGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateGatewayAsync(CreateGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new Gateway in a given project and location.

Parameters
NameDescription
requestCreateGatewayRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

DeleteApi(DeleteApiRequest, CallOptions)

public virtual Operation DeleteApi(DeleteApiRequest request, CallOptions options)

Deletes a single Api.

Parameters
NameDescription
requestDeleteApiRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteApi(DeleteApiRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteApi(DeleteApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Api.

Parameters
NameDescription
requestDeleteApiRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteApiAsync(DeleteApiRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteApiAsync(DeleteApiRequest request, CallOptions options)

Deletes a single Api.

Parameters
NameDescription
requestDeleteApiRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteApiAsync(DeleteApiRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteApiAsync(DeleteApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Api.

Parameters
NameDescription
requestDeleteApiRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteApiConfig(DeleteApiConfigRequest, CallOptions)

public virtual Operation DeleteApiConfig(DeleteApiConfigRequest request, CallOptions options)

Deletes a single ApiConfig.

Parameters
NameDescription
requestDeleteApiConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteApiConfig(DeleteApiConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteApiConfig(DeleteApiConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single ApiConfig.

Parameters
NameDescription
requestDeleteApiConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteApiConfigAsync(DeleteApiConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteApiConfigAsync(DeleteApiConfigRequest request, CallOptions options)

Deletes a single ApiConfig.

Parameters
NameDescription
requestDeleteApiConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteApiConfigAsync(DeleteApiConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteApiConfigAsync(DeleteApiConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single ApiConfig.

Parameters
NameDescription
requestDeleteApiConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteGateway(DeleteGatewayRequest, CallOptions)

public virtual Operation DeleteGateway(DeleteGatewayRequest request, CallOptions options)

Deletes a single Gateway.

Parameters
NameDescription
requestDeleteGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteGateway(DeleteGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteGateway(DeleteGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Gateway.

Parameters
NameDescription
requestDeleteGatewayRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteGatewayAsync(DeleteGatewayRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteGatewayAsync(DeleteGatewayRequest request, CallOptions options)

Deletes a single Gateway.

Parameters
NameDescription
requestDeleteGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteGatewayAsync(DeleteGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteGatewayAsync(DeleteGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Gateway.

Parameters
NameDescription
requestDeleteGatewayRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetApi(GetApiRequest, CallOptions)

public virtual Api GetApi(GetApiRequest request, CallOptions options)

Gets details of a single Api.

Parameters
NameDescription
requestGetApiRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Api

The response received from the server.

GetApi(GetApiRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Api GetApi(GetApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Api.

Parameters
NameDescription
requestGetApiRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Api

The response received from the server.

GetApiAsync(GetApiRequest, CallOptions)

public virtual AsyncUnaryCall<Api> GetApiAsync(GetApiRequest request, CallOptions options)

Gets details of a single Api.

Parameters
NameDescription
requestGetApiRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Api>

The call object.

GetApiAsync(GetApiRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Api> GetApiAsync(GetApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Api.

Parameters
NameDescription
requestGetApiRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Api>

The call object.

GetApiConfig(GetApiConfigRequest, CallOptions)

public virtual ApiConfig GetApiConfig(GetApiConfigRequest request, CallOptions options)

Gets details of a single ApiConfig.

Parameters
NameDescription
requestGetApiConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ApiConfig

The response received from the server.

GetApiConfig(GetApiConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ApiConfig GetApiConfig(GetApiConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single ApiConfig.

Parameters
NameDescription
requestGetApiConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ApiConfig

The response received from the server.

GetApiConfigAsync(GetApiConfigRequest, CallOptions)

public virtual AsyncUnaryCall<ApiConfig> GetApiConfigAsync(GetApiConfigRequest request, CallOptions options)

Gets details of a single ApiConfig.

Parameters
NameDescription
requestGetApiConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ApiConfig>

The call object.

GetApiConfigAsync(GetApiConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ApiConfig> GetApiConfigAsync(GetApiConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single ApiConfig.

Parameters
NameDescription
requestGetApiConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ApiConfig>

The call object.

GetGateway(GetGatewayRequest, CallOptions)

public virtual Gateway GetGateway(GetGatewayRequest request, CallOptions options)

Gets details of a single Gateway.

Parameters
NameDescription
requestGetGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Gateway

The response received from the server.

GetGateway(GetGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Gateway GetGateway(GetGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Gateway.

Parameters
NameDescription
requestGetGatewayRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Gateway

The response received from the server.

GetGatewayAsync(GetGatewayRequest, CallOptions)

public virtual AsyncUnaryCall<Gateway> GetGatewayAsync(GetGatewayRequest request, CallOptions options)

Gets details of a single Gateway.

Parameters
NameDescription
requestGetGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Gateway>

The call object.

GetGatewayAsync(GetGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Gateway> GetGatewayAsync(GetGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Gateway.

Parameters
NameDescription
requestGetGatewayRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Gateway>

The call object.

ListApiConfigs(ListApiConfigsRequest, CallOptions)

public virtual ListApiConfigsResponse ListApiConfigs(ListApiConfigsRequest request, CallOptions options)

Lists ApiConfigs in a given project and location.

Parameters
NameDescription
requestListApiConfigsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListApiConfigsResponse

The response received from the server.

ListApiConfigs(ListApiConfigsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListApiConfigsResponse ListApiConfigs(ListApiConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists ApiConfigs in a given project and location.

Parameters
NameDescription
requestListApiConfigsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListApiConfigsResponse

The response received from the server.

ListApiConfigsAsync(ListApiConfigsRequest, CallOptions)

public virtual AsyncUnaryCall<ListApiConfigsResponse> ListApiConfigsAsync(ListApiConfigsRequest request, CallOptions options)

Lists ApiConfigs in a given project and location.

Parameters
NameDescription
requestListApiConfigsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListApiConfigsResponse>

The call object.

ListApiConfigsAsync(ListApiConfigsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListApiConfigsResponse> ListApiConfigsAsync(ListApiConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists ApiConfigs in a given project and location.

Parameters
NameDescription
requestListApiConfigsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListApiConfigsResponse>

The call object.

ListApis(ListApisRequest, CallOptions)

public virtual ListApisResponse ListApis(ListApisRequest request, CallOptions options)

Lists Apis in a given project and location.

Parameters
NameDescription
requestListApisRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListApisResponse

The response received from the server.

ListApis(ListApisRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListApisResponse ListApis(ListApisRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists Apis in a given project and location.

Parameters
NameDescription
requestListApisRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListApisResponse

The response received from the server.

ListApisAsync(ListApisRequest, CallOptions)

public virtual AsyncUnaryCall<ListApisResponse> ListApisAsync(ListApisRequest request, CallOptions options)

Lists Apis in a given project and location.

Parameters
NameDescription
requestListApisRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListApisResponse>

The call object.

ListApisAsync(ListApisRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListApisResponse> ListApisAsync(ListApisRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists Apis in a given project and location.

Parameters
NameDescription
requestListApisRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListApisResponse>

The call object.

ListGateways(ListGatewaysRequest, CallOptions)

public virtual ListGatewaysResponse ListGateways(ListGatewaysRequest request, CallOptions options)

Lists Gateways in a given project and location.

Parameters
NameDescription
requestListGatewaysRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListGatewaysResponse

The response received from the server.

ListGateways(ListGatewaysRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListGatewaysResponse ListGateways(ListGatewaysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists Gateways in a given project and location.

Parameters
NameDescription
requestListGatewaysRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListGatewaysResponse

The response received from the server.

ListGatewaysAsync(ListGatewaysRequest, CallOptions)

public virtual AsyncUnaryCall<ListGatewaysResponse> ListGatewaysAsync(ListGatewaysRequest request, CallOptions options)

Lists Gateways in a given project and location.

Parameters
NameDescription
requestListGatewaysRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListGatewaysResponse>

The call object.

ListGatewaysAsync(ListGatewaysRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListGatewaysResponse> ListGatewaysAsync(ListGatewaysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists Gateways in a given project and location.

Parameters
NameDescription
requestListGatewaysRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListGatewaysResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override ApiGatewayService.ApiGatewayServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
ApiGatewayService.ApiGatewayServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.ApiGateway.V1.ApiGatewayService.ApiGatewayServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateApi(UpdateApiRequest, CallOptions)

public virtual Operation UpdateApi(UpdateApiRequest request, CallOptions options)

Updates the parameters of a single Api.

Parameters
NameDescription
requestUpdateApiRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateApi(UpdateApiRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateApi(UpdateApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the parameters of a single Api.

Parameters
NameDescription
requestUpdateApiRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateApiAsync(UpdateApiRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateApiAsync(UpdateApiRequest request, CallOptions options)

Updates the parameters of a single Api.

Parameters
NameDescription
requestUpdateApiRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateApiAsync(UpdateApiRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateApiAsync(UpdateApiRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the parameters of a single Api.

Parameters
NameDescription
requestUpdateApiRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateApiConfig(UpdateApiConfigRequest, CallOptions)

public virtual Operation UpdateApiConfig(UpdateApiConfigRequest request, CallOptions options)

Updates the parameters of a single ApiConfig.

Parameters
NameDescription
requestUpdateApiConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateApiConfig(UpdateApiConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateApiConfig(UpdateApiConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the parameters of a single ApiConfig.

Parameters
NameDescription
requestUpdateApiConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateApiConfigAsync(UpdateApiConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateApiConfigAsync(UpdateApiConfigRequest request, CallOptions options)

Updates the parameters of a single ApiConfig.

Parameters
NameDescription
requestUpdateApiConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateApiConfigAsync(UpdateApiConfigRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateApiConfigAsync(UpdateApiConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the parameters of a single ApiConfig.

Parameters
NameDescription
requestUpdateApiConfigRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateGateway(UpdateGatewayRequest, CallOptions)

public virtual Operation UpdateGateway(UpdateGatewayRequest request, CallOptions options)

Updates the parameters of a single Gateway.

Parameters
NameDescription
requestUpdateGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateGateway(UpdateGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateGateway(UpdateGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the parameters of a single Gateway.

Parameters
NameDescription
requestUpdateGatewayRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateGatewayAsync(UpdateGatewayRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateGatewayAsync(UpdateGatewayRequest request, CallOptions options)

Updates the parameters of a single Gateway.

Parameters
NameDescription
requestUpdateGatewayRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateGatewayAsync(UpdateGatewayRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateGatewayAsync(UpdateGatewayRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the parameters of a single Gateway.

Parameters
NameDescription
requestUpdateGatewayRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.