API Gateway v1 API - Class ApiGatewayServiceClientImpl (2.4.0) 

public sealed class ApiGatewayServiceClientImpl : ApiGatewayServiceClient

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

ApiGatewayService client wrapper implementation, for convenient use.

Inheritance

object > ApiGatewayServiceClient > ApiGatewayServiceClientImpl

Namespace

Google.Cloud.ApiGateway.V1

Assembly

Google.Cloud.ApiGateway.V1.dll

Remarks

The API Gateway Service is the interface for managing API Gateways.

Constructors

ApiGatewayServiceClientImpl(ApiGatewayServiceClient, ApiGatewayServiceSettings, ILogger)

public ApiGatewayServiceClientImpl(ApiGatewayService.ApiGatewayServiceClient grpcClient, ApiGatewayServiceSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient ApiGatewayServiceApiGatewayServiceClient

The underlying gRPC client.
settings ApiGatewayServiceSettings

The base ApiGatewayServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateApiConfigOperationsClient

public override OperationsClient CreateApiConfigOperationsClient { get; }

The long-running operations client for CreateApiConfig.

Property Value
Type Description
OperationsClient
Overrides

CreateApiOperationsClient

public override OperationsClient CreateApiOperationsClient { get; }

The long-running operations client for CreateApi.

Property Value
Type Description
OperationsClient
Overrides

CreateGatewayOperationsClient

public override OperationsClient CreateGatewayOperationsClient { get; }

The long-running operations client for CreateGateway.

Property Value
Type Description
OperationsClient
Overrides

DeleteApiConfigOperationsClient

public override OperationsClient DeleteApiConfigOperationsClient { get; }

The long-running operations client for DeleteApiConfig.

Property Value
Type Description
OperationsClient
Overrides

DeleteApiOperationsClient

public override OperationsClient DeleteApiOperationsClient { get; }

The long-running operations client for DeleteApi.

Property Value
Type Description
OperationsClient
Overrides

DeleteGatewayOperationsClient

public override OperationsClient DeleteGatewayOperationsClient { get; }

The long-running operations client for DeleteGateway.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override ApiGatewayService.ApiGatewayServiceClient GrpcClient { get; }

The underlying gRPC ApiGatewayService client

Property Value
Type Description
ApiGatewayServiceApiGatewayServiceClient
Overrides

UpdateApiConfigOperationsClient

public override OperationsClient UpdateApiConfigOperationsClient { get; }

The long-running operations client for UpdateApiConfig.

Property Value
Type Description
OperationsClient
Overrides

UpdateApiOperationsClient

public override OperationsClient UpdateApiOperationsClient { get; }

The long-running operations client for UpdateApi.

Property Value
Type Description
OperationsClient
Overrides

UpdateGatewayOperationsClient

public override OperationsClient UpdateGatewayOperationsClient { get; }

The long-running operations client for UpdateGateway.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateApi(CreateApiRequest, CallSettings)

public override Operation<Api, OperationMetadata> CreateApi(CreateApiRequest request, CallSettings callSettings = null)

Creates a new Api in a given project and location.

Parameters
Name Description
request CreateApiRequest

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
OperationApiOperationMetadata

The RPC response.
Overrides

CreateApiAsync(CreateApiRequest, CallSettings)

public override Task<Operation<Api, OperationMetadata>> CreateApiAsync(CreateApiRequest request, CallSettings callSettings = null)

Creates a new Api in a given project and location.

Parameters
Name Description
request CreateApiRequest

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
TaskOperationApiOperationMetadata

A Task containing the RPC response.
Overrides

CreateApiConfig(CreateApiConfigRequest, CallSettings)

public override Operation<ApiConfig, OperationMetadata> CreateApiConfig(CreateApiConfigRequest request, CallSettings callSettings = null)

Creates a new ApiConfig in a given project and location.

Parameters
Name Description
request CreateApiConfigRequest

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
OperationApiConfigOperationMetadata

The RPC response.
Overrides

CreateApiConfigAsync(CreateApiConfigRequest, CallSettings)

public override Task<Operation<ApiConfig, OperationMetadata>> CreateApiConfigAsync(CreateApiConfigRequest request, CallSettings callSettings = null)

Creates a new ApiConfig in a given project and location.

Parameters
Name Description
request CreateApiConfigRequest

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
TaskOperationApiConfigOperationMetadata

A Task containing the RPC response.
Overrides

CreateGateway(CreateGatewayRequest, CallSettings)

public override Operation<Gateway, OperationMetadata> CreateGateway(CreateGatewayRequest request, CallSettings callSettings = null)

Creates a new Gateway in a given project and location.

Parameters
Name Description
request CreateGatewayRequest

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
OperationGatewayOperationMetadata

The RPC response.
Overrides

CreateGatewayAsync(CreateGatewayRequest, CallSettings)

public override Task<Operation<Gateway, OperationMetadata>> CreateGatewayAsync(CreateGatewayRequest request, CallSettings callSettings = null)

Creates a new Gateway in a given project and location.

Parameters
Name Description
request CreateGatewayRequest

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
TaskOperationGatewayOperationMetadata

A Task containing the RPC response.
Overrides

DeleteApi(DeleteApiRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteApi(DeleteApiRequest request, CallSettings callSettings = null)

Deletes a single Api.

Parameters
Name Description
request DeleteApiRequest

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

DeleteApiAsync(DeleteApiRequest, CallSettings)

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

Deletes a single Api.

Parameters
Name Description
request DeleteApiRequest

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

DeleteApiConfig(DeleteApiConfigRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteApiConfig(DeleteApiConfigRequest request, CallSettings callSettings = null)

Deletes a single ApiConfig.

Parameters
Name Description
request DeleteApiConfigRequest

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

DeleteApiConfigAsync(DeleteApiConfigRequest, CallSettings)

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

Deletes a single ApiConfig.

Parameters
Name Description
request DeleteApiConfigRequest

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

DeleteGateway(DeleteGatewayRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteGateway(DeleteGatewayRequest request, CallSettings callSettings = null)

Deletes a single Gateway.

Parameters
Name Description
request DeleteGatewayRequest

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

DeleteGatewayAsync(DeleteGatewayRequest, CallSettings)

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

Deletes a single Gateway.

Parameters
Name Description
request DeleteGatewayRequest

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

GetApi(GetApiRequest, CallSettings)

public override Api GetApi(GetApiRequest request, CallSettings callSettings = null)

Gets details of a single Api.

Parameters
Name Description
request GetApiRequest

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
Api

The RPC response.
Overrides

GetApiAsync(GetApiRequest, CallSettings)

public override Task<Api> GetApiAsync(GetApiRequest request, CallSettings callSettings = null)

Gets details of a single Api.

Parameters
Name Description
request GetApiRequest

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
TaskApi

A Task containing the RPC response.
Overrides

GetApiConfig(GetApiConfigRequest, CallSettings)

public override ApiConfig GetApiConfig(GetApiConfigRequest request, CallSettings callSettings = null)

Gets details of a single ApiConfig.

Parameters
Name Description
request GetApiConfigRequest

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
ApiConfig

The RPC response.
Overrides

GetApiConfigAsync(GetApiConfigRequest, CallSettings)

public override Task<ApiConfig> GetApiConfigAsync(GetApiConfigRequest request, CallSettings callSettings = null)

Gets details of a single ApiConfig.

Parameters
Name Description
request GetApiConfigRequest

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
TaskApiConfig

A Task containing the RPC response.
Overrides

GetGateway(GetGatewayRequest, CallSettings)

public override Gateway GetGateway(GetGatewayRequest request, CallSettings callSettings = null)

Gets details of a single Gateway.

Parameters
Name Description
request GetGatewayRequest

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
Gateway

The RPC response.
Overrides

GetGatewayAsync(GetGatewayRequest, CallSettings)

public override Task<Gateway> GetGatewayAsync(GetGatewayRequest request, CallSettings callSettings = null)

Gets details of a single Gateway.

Parameters
Name Description
request GetGatewayRequest

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
TaskGateway

A Task containing the RPC response.
Overrides

ListApiConfigs(ListApiConfigsRequest, CallSettings)

public override PagedEnumerable<ListApiConfigsResponse, ApiConfig> ListApiConfigs(ListApiConfigsRequest request, CallSettings callSettings = null)

Lists ApiConfigs in a given project and location.

Parameters
Name Description
request ListApiConfigsRequest

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
PagedEnumerableListApiConfigsResponseApiConfig

A pageable sequence of ApiConfig resources.
Overrides

ListApiConfigsAsync(ListApiConfigsRequest, CallSettings)

public override PagedAsyncEnumerable<ListApiConfigsResponse, ApiConfig> ListApiConfigsAsync(ListApiConfigsRequest request, CallSettings callSettings = null)

Lists ApiConfigs in a given project and location.

Parameters
Name Description
request ListApiConfigsRequest

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
PagedAsyncEnumerableListApiConfigsResponseApiConfig

A pageable asynchronous sequence of ApiConfig resources.
Overrides

ListApis(ListApisRequest, CallSettings)

public override PagedEnumerable<ListApisResponse, Api> ListApis(ListApisRequest request, CallSettings callSettings = null)

Lists Apis in a given project and location.

Parameters
Name Description
request ListApisRequest

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
PagedEnumerableListApisResponseApi

A pageable sequence of Api resources.
Overrides

ListApisAsync(ListApisRequest, CallSettings)

public override PagedAsyncEnumerable<ListApisResponse, Api> ListApisAsync(ListApisRequest request, CallSettings callSettings = null)

Lists Apis in a given project and location.

Parameters
Name Description
request ListApisRequest

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
PagedAsyncEnumerableListApisResponseApi

A pageable asynchronous sequence of Api resources.
Overrides

ListGateways(ListGatewaysRequest, CallSettings)

public override PagedEnumerable<ListGatewaysResponse, Gateway> ListGateways(ListGatewaysRequest request, CallSettings callSettings = null)

Lists Gateways in a given project and location.

Parameters
Name Description
request ListGatewaysRequest

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
PagedEnumerableListGatewaysResponseGateway

A pageable sequence of Gateway resources.
Overrides

ListGatewaysAsync(ListGatewaysRequest, CallSettings)

public override PagedAsyncEnumerable<ListGatewaysResponse, Gateway> ListGatewaysAsync(ListGatewaysRequest request, CallSettings callSettings = null)

Lists Gateways in a given project and location.

Parameters
Name Description
request ListGatewaysRequest

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
PagedAsyncEnumerableListGatewaysResponseGateway

A pageable asynchronous sequence of Gateway resources.
Overrides

UpdateApi(UpdateApiRequest, CallSettings)

public override Operation<Api, OperationMetadata> UpdateApi(UpdateApiRequest request, CallSettings callSettings = null)

Updates the parameters of a single Api.

Parameters
Name Description
request UpdateApiRequest

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
OperationApiOperationMetadata

The RPC response.
Overrides

UpdateApiAsync(UpdateApiRequest, CallSettings)

public override Task<Operation<Api, OperationMetadata>> UpdateApiAsync(UpdateApiRequest request, CallSettings callSettings = null)

Updates the parameters of a single Api.

Parameters
Name Description
request UpdateApiRequest

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
TaskOperationApiOperationMetadata

A Task containing the RPC response.
Overrides

UpdateApiConfig(UpdateApiConfigRequest, CallSettings)

public override Operation<ApiConfig, OperationMetadata> UpdateApiConfig(UpdateApiConfigRequest request, CallSettings callSettings = null)

Updates the parameters of a single ApiConfig.

Parameters
Name Description
request UpdateApiConfigRequest

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
OperationApiConfigOperationMetadata

The RPC response.
Overrides

UpdateApiConfigAsync(UpdateApiConfigRequest, CallSettings)

public override Task<Operation<ApiConfig, OperationMetadata>> UpdateApiConfigAsync(UpdateApiConfigRequest request, CallSettings callSettings = null)

Updates the parameters of a single ApiConfig.

Parameters
Name Description
request UpdateApiConfigRequest

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
TaskOperationApiConfigOperationMetadata

A Task containing the RPC response.
Overrides

UpdateGateway(UpdateGatewayRequest, CallSettings)

public override Operation<Gateway, OperationMetadata> UpdateGateway(UpdateGatewayRequest request, CallSettings callSettings = null)

Updates the parameters of a single Gateway.

Parameters
Name Description
request UpdateGatewayRequest

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
OperationGatewayOperationMetadata

The RPC response.
Overrides

UpdateGatewayAsync(UpdateGatewayRequest, CallSettings)

public override Task<Operation<Gateway, OperationMetadata>> UpdateGatewayAsync(UpdateGatewayRequest request, CallSettings callSettings = null)

Updates the parameters of a single Gateway.

Parameters
Name Description
request UpdateGatewayRequest

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
TaskOperationGatewayOperationMetadata

A Task containing the RPC response.
Overrides