API Gateway v1 API - Class ApiGatewayService.ApiGatewayServiceBase (2.3.0)

Version 2.3.0

• 2.4.0 (latest)
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(ApiGatewayService), "BindService")]
public abstract class ApiGatewayService.ApiGatewayServiceBase

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

Base class for server-side implementations of ApiGatewayService

Inheritance

object > ApiGatewayService.ApiGatewayServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.ApiGateway.V1

Assembly

Google.Cloud.ApiGateway.V1.dll

Methods

CreateApi(CreateApiRequest, ServerCallContext)

public virtual Task<Operation> CreateApi(CreateApiRequest request, ServerCallContext context)

Creates a new Api in a given project and location.

Parameters
Name	Description
request	CreateApiRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateApiConfig(CreateApiConfigRequest, ServerCallContext)

public virtual Task<Operation> CreateApiConfig(CreateApiConfigRequest request, ServerCallContext context)

Creates a new ApiConfig in a given project and location.

Parameters
Name	Description
request	CreateApiConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateGateway(CreateGatewayRequest, ServerCallContext)

public virtual Task<Operation> CreateGateway(CreateGatewayRequest request, ServerCallContext context)

Creates a new Gateway in a given project and location.

Parameters
Name	Description
request	CreateGatewayRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteApi(DeleteApiRequest, ServerCallContext)

public virtual Task<Operation> DeleteApi(DeleteApiRequest request, ServerCallContext context)

Deletes a single Api.

Parameters
Name	Description
request	DeleteApiRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteApiConfig(DeleteApiConfigRequest, ServerCallContext)

public virtual Task<Operation> DeleteApiConfig(DeleteApiConfigRequest request, ServerCallContext context)

Deletes a single ApiConfig.

Parameters
Name	Description
request	DeleteApiConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteGateway(DeleteGatewayRequest, ServerCallContext)

public virtual Task<Operation> DeleteGateway(DeleteGatewayRequest request, ServerCallContext context)

Deletes a single Gateway.

Parameters
Name	Description
request	DeleteGatewayRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetApi(GetApiRequest, ServerCallContext)

public virtual Task<Api> GetApi(GetApiRequest request, ServerCallContext context)

Gets details of a single Api.

Parameters
Name	Description
request	GetApiRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskApi	The response to send back to the client (wrapped by a task).

GetApiConfig(GetApiConfigRequest, ServerCallContext)

public virtual Task<ApiConfig> GetApiConfig(GetApiConfigRequest request, ServerCallContext context)

Gets details of a single ApiConfig.

Parameters
Name	Description
request	GetApiConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskApiConfig	The response to send back to the client (wrapped by a task).

GetGateway(GetGatewayRequest, ServerCallContext)

public virtual Task<Gateway> GetGateway(GetGatewayRequest request, ServerCallContext context)

Gets details of a single Gateway.

Parameters
Name	Description
request	GetGatewayRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGateway	The response to send back to the client (wrapped by a task).

ListApiConfigs(ListApiConfigsRequest, ServerCallContext)

public virtual Task<ListApiConfigsResponse> ListApiConfigs(ListApiConfigsRequest request, ServerCallContext context)

Lists ApiConfigs in a given project and location.

Parameters
Name	Description
request	ListApiConfigsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListApiConfigsResponse	The response to send back to the client (wrapped by a task).

ListApis(ListApisRequest, ServerCallContext)

public virtual Task<ListApisResponse> ListApis(ListApisRequest request, ServerCallContext context)

Lists Apis in a given project and location.

Parameters
Name	Description
request	ListApisRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListApisResponse	The response to send back to the client (wrapped by a task).

ListGateways(ListGatewaysRequest, ServerCallContext)

public virtual Task<ListGatewaysResponse> ListGateways(ListGatewaysRequest request, ServerCallContext context)

Lists Gateways in a given project and location.

Parameters
Name	Description
request	ListGatewaysRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListGatewaysResponse	The response to send back to the client (wrapped by a task).

UpdateApi(UpdateApiRequest, ServerCallContext)

public virtual Task<Operation> UpdateApi(UpdateApiRequest request, ServerCallContext context)

Updates the parameters of a single Api.

Parameters
Name	Description
request	UpdateApiRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateApiConfig(UpdateApiConfigRequest, ServerCallContext)

public virtual Task<Operation> UpdateApiConfig(UpdateApiConfigRequest request, ServerCallContext context)

Updates the parameters of a single ApiConfig.

Parameters
Name	Description
request	UpdateApiConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateGateway(UpdateGatewayRequest, ServerCallContext)

public virtual Task<Operation> UpdateGateway(UpdateGatewayRequest request, ServerCallContext context)

Updates the parameters of a single Gateway.

Parameters
Name	Description
request	UpdateGatewayRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).