public sealed class ApiGatewayServiceClientImpl : ApiGatewayServiceClientApiGatewayService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.ApiGateway.V1Assembly
Google.Cloud.ApiGateway.V1.dll
Remarks
The API Gateway Service is the interface for managing API Gateways.
Constructors
ApiGatewayServiceClientImpl(ApiGatewayService.ApiGatewayServiceClient, ApiGatewayServiceSettings)
public ApiGatewayServiceClientImpl(ApiGatewayService.ApiGatewayServiceClient grpcClient, ApiGatewayServiceSettings settings)Constructs a client wrapper for the ApiGatewayService service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | ApiGatewayService.ApiGatewayServiceClientThe underlying gRPC client. |
settings | ApiGatewayServiceSettingsThe base ApiGatewayServiceSettings used within this client. |
Properties
CreateApiConfigOperationsClient
public override OperationsClient CreateApiConfigOperationsClient { get; }The long-running operations client for CreateApiConfig.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateApiOperationsClient
public override OperationsClient CreateApiOperationsClient { get; }The long-running operations client for CreateApi.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateGatewayOperationsClient
public override OperationsClient CreateGatewayOperationsClient { get; }The long-running operations client for CreateGateway.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteApiConfigOperationsClient
public override OperationsClient DeleteApiConfigOperationsClient { get; }The long-running operations client for DeleteApiConfig.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteApiOperationsClient
public override OperationsClient DeleteApiOperationsClient { get; }The long-running operations client for DeleteApi.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteGatewayOperationsClient
public override OperationsClient DeleteGatewayOperationsClient { get; }The long-running operations client for DeleteGateway.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override ApiGatewayService.ApiGatewayServiceClient GrpcClient { get; }The underlying gRPC ApiGatewayService client
| Property Value | |
|---|---|
| Type | Description |
ApiGatewayService.ApiGatewayServiceClient | |
UpdateApiConfigOperationsClient
public override OperationsClient UpdateApiConfigOperationsClient { get; }The long-running operations client for UpdateApiConfig.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateApiOperationsClient
public override OperationsClient UpdateApiOperationsClient { get; }The long-running operations client for UpdateApi.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateGatewayOperationsClient
public override OperationsClient UpdateGatewayOperationsClient { get; }The long-running operations client for UpdateGateway.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
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 | CreateApiRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Api, OperationMetadata> | The RPC response. |
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 | CreateApiRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
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 | CreateApiConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<ApiConfig, OperationMetadata> | The RPC response. |
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 | CreateApiConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
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 | CreateGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Gateway, OperationMetadata> | The RPC response. |
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 | CreateGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |
DeleteApi(DeleteApiRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteApi(DeleteApiRequest request, CallSettings callSettings = null)Deletes a single Api.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteApiRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteApiAsync(DeleteApiRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteApiAsync(DeleteApiRequest request, CallSettings callSettings = null)Deletes a single Api.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteApiRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
DeleteApiConfig(DeleteApiConfigRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteApiConfig(DeleteApiConfigRequest request, CallSettings callSettings = null)Deletes a single ApiConfig.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteApiConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteApiConfigAsync(DeleteApiConfigRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteApiConfigAsync(DeleteApiConfigRequest request, CallSettings callSettings = null)Deletes a single ApiConfig.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteApiConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
DeleteGateway(DeleteGatewayRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteGateway(DeleteGatewayRequest request, CallSettings callSettings = null)Deletes a single Gateway.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteGatewayAsync(DeleteGatewayRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteGatewayAsync(DeleteGatewayRequest request, CallSettings callSettings = null)Deletes a single Gateway.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
GetApi(GetApiRequest, CallSettings)
public override Api GetApi(GetApiRequest request, CallSettings callSettings = null)Gets details of a single Api.
| Parameters | |
|---|---|
| Name | Description |
request | GetApiRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Api | The RPC response. |
GetApiAsync(GetApiRequest, CallSettings)
public override Task<Api> GetApiAsync(GetApiRequest request, CallSettings callSettings = null)Gets details of a single Api.
| Parameters | |
|---|---|
| Name | Description |
request | GetApiRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Api> | A Task containing the RPC response. |
GetApiConfig(GetApiConfigRequest, CallSettings)
public override ApiConfig GetApiConfig(GetApiConfigRequest request, CallSettings callSettings = null)Gets details of a single ApiConfig.
| Parameters | |
|---|---|
| Name | Description |
request | GetApiConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ApiConfig | The RPC response. |
GetApiConfigAsync(GetApiConfigRequest, CallSettings)
public override Task<ApiConfig> GetApiConfigAsync(GetApiConfigRequest request, CallSettings callSettings = null)Gets details of a single ApiConfig.
| Parameters | |
|---|---|
| Name | Description |
request | GetApiConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ApiConfig> | A Task containing the RPC response. |
GetGateway(GetGatewayRequest, CallSettings)
public override Gateway GetGateway(GetGatewayRequest request, CallSettings callSettings = null)Gets details of a single Gateway.
| Parameters | |
|---|---|
| Name | Description |
request | GetGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Gateway | The RPC response. |
GetGatewayAsync(GetGatewayRequest, CallSettings)
public override Task<Gateway> GetGatewayAsync(GetGatewayRequest request, CallSettings callSettings = null)Gets details of a single Gateway.
| Parameters | |
|---|---|
| Name | Description |
request | GetGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Gateway> | A Task containing the RPC response. |
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 | ListApiConfigsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListApiConfigsResponse, ApiConfig> | A pageable sequence of ApiConfig resources. |
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 | ListApiConfigsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListApiConfigsResponse, ApiConfig> | A pageable asynchronous sequence of ApiConfig resources. |
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 | ListApisRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListApisResponse, Api> | A pageable sequence of Api resources. |
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 | ListApisRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListApisResponse, Api> | A pageable asynchronous sequence of Api resources. |
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 | ListGatewaysRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListGatewaysResponse, Gateway> | A pageable sequence of Gateway resources. |
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 | ListGatewaysRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListGatewaysResponse, Gateway> | A pageable asynchronous sequence of Gateway resources. |
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 | UpdateApiRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Api, OperationMetadata> | The RPC response. |
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 | UpdateApiRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Api, OperationMetadata>> | A Task containing the RPC response. |
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 | UpdateApiConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<ApiConfig, OperationMetadata> | The RPC response. |
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 | UpdateApiConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<ApiConfig, OperationMetadata>> | A Task containing the RPC response. |
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 | UpdateGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Gateway, OperationMetadata> | The RPC response. |
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 | UpdateGatewayRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Gateway, OperationMetadata>> | A Task containing the RPC response. |