Class protos.google.cloud.apigateway.v1.ApiGatewayService (2.2.2)

Version latest

• 2.2.2 (latest)
• 2.2.1
• 2.1.2
• 1.2.1
• 1.1.6

Represents an ApiGatewayService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.apigateway.v1.ApiGatewayService

Package

@google-cloud/api-gateway

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new ApiGatewayService service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): ApiGatewayService;

Creates new ApiGatewayService service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
ApiGatewayService	RPC service. Useful where requests and/or responses are streamed.

createApi(request, callback)

public createApi(request: google.cloud.apigateway.v1.ICreateApiRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.CreateApiCallback): void;

Calls CreateApi.

Parameters
Name	Description
request	ICreateApiRequest CreateApiRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.CreateApiCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createApi(request)

public createApi(request: google.cloud.apigateway.v1.ICreateApiRequest): Promise<google.longrunning.Operation>;

Calls CreateApi.

Parameter
Name	Description
request	ICreateApiRequest CreateApiRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

createApiConfig(request, callback)

public createApiConfig(request: google.cloud.apigateway.v1.ICreateApiConfigRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfigCallback): void;

Calls CreateApiConfig.

Parameters
Name	Description
request	ICreateApiConfigRequest CreateApiConfigRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfigCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createApiConfig(request)

public createApiConfig(request: google.cloud.apigateway.v1.ICreateApiConfigRequest): Promise<google.longrunning.Operation>;

Calls CreateApiConfig.

Parameter
Name	Description
request	ICreateApiConfigRequest CreateApiConfigRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

createGateway(request, callback)

public createGateway(request: google.cloud.apigateway.v1.ICreateGatewayRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.CreateGatewayCallback): void;

Calls CreateGateway.

Parameters
Name	Description
request	ICreateGatewayRequest CreateGatewayRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.CreateGatewayCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createGateway(request)

public createGateway(request: google.cloud.apigateway.v1.ICreateGatewayRequest): Promise<google.longrunning.Operation>;

Calls CreateGateway.

Parameter
Name	Description
request	ICreateGatewayRequest CreateGatewayRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteApi(request, callback)

public deleteApi(request: google.cloud.apigateway.v1.IDeleteApiRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.DeleteApiCallback): void;

Calls DeleteApi.

Parameters
Name	Description
request	IDeleteApiRequest DeleteApiRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.DeleteApiCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteApi(request)

public deleteApi(request: google.cloud.apigateway.v1.IDeleteApiRequest): Promise<google.longrunning.Operation>;

Calls DeleteApi.

Parameter
Name	Description
request	IDeleteApiRequest DeleteApiRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteApiConfig(request, callback)

public deleteApiConfig(request: google.cloud.apigateway.v1.IDeleteApiConfigRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfigCallback): void;

Calls DeleteApiConfig.

Parameters
Name	Description
request	IDeleteApiConfigRequest DeleteApiConfigRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfigCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteApiConfig(request)

public deleteApiConfig(request: google.cloud.apigateway.v1.IDeleteApiConfigRequest): Promise<google.longrunning.Operation>;

Calls DeleteApiConfig.

Parameter
Name	Description
request	IDeleteApiConfigRequest DeleteApiConfigRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteGateway(request, callback)

public deleteGateway(request: google.cloud.apigateway.v1.IDeleteGatewayRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.DeleteGatewayCallback): void;

Calls DeleteGateway.

Parameters
Name	Description
request	IDeleteGatewayRequest DeleteGatewayRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.DeleteGatewayCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteGateway(request)

public deleteGateway(request: google.cloud.apigateway.v1.IDeleteGatewayRequest): Promise<google.longrunning.Operation>;

Calls DeleteGateway.

Parameter
Name	Description
request	IDeleteGatewayRequest DeleteGatewayRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

getApi(request, callback)

public getApi(request: google.cloud.apigateway.v1.IGetApiRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.GetApiCallback): void;

Calls GetApi.

Parameters
Name	Description
request	IGetApiRequest GetApiRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.GetApiCallback Node-style callback called with the error, if any, and Api

Returns
Type	Description
void

getApi(request)

public getApi(request: google.cloud.apigateway.v1.IGetApiRequest): Promise<google.cloud.apigateway.v1.Api>;

Calls GetApi.

Parameter
Name	Description
request	IGetApiRequest GetApiRequest message or plain object

Returns
Type	Description
Promise<google.cloud.apigateway.v1.Api>	Promise

getApiConfig(request, callback)

public getApiConfig(request: google.cloud.apigateway.v1.IGetApiConfigRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.GetApiConfigCallback): void;

Calls GetApiConfig.

Parameters
Name	Description
request	IGetApiConfigRequest GetApiConfigRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.GetApiConfigCallback Node-style callback called with the error, if any, and ApiConfig

Returns
Type	Description
void

getApiConfig(request)

public getApiConfig(request: google.cloud.apigateway.v1.IGetApiConfigRequest): Promise<google.cloud.apigateway.v1.ApiConfig>;

Calls GetApiConfig.

Parameter
Name	Description
request	IGetApiConfigRequest GetApiConfigRequest message or plain object

Returns
Type	Description
Promise<google.cloud.apigateway.v1.ApiConfig>	Promise

getGateway(request, callback)

public getGateway(request: google.cloud.apigateway.v1.IGetGatewayRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.GetGatewayCallback): void;

Calls GetGateway.

Parameters
Name	Description
request	IGetGatewayRequest GetGatewayRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.GetGatewayCallback Node-style callback called with the error, if any, and Gateway

Returns
Type	Description
void

getGateway(request)

public getGateway(request: google.cloud.apigateway.v1.IGetGatewayRequest): Promise<google.cloud.apigateway.v1.Gateway>;

Calls GetGateway.

Parameter
Name	Description
request	IGetGatewayRequest GetGatewayRequest message or plain object

Returns
Type	Description
Promise<google.cloud.apigateway.v1.Gateway>	Promise

listApiConfigs(request, callback)

public listApiConfigs(request: google.cloud.apigateway.v1.IListApiConfigsRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigsCallback): void;

Calls ListApiConfigs.

Parameters
Name	Description
request	IListApiConfigsRequest ListApiConfigsRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigsCallback Node-style callback called with the error, if any, and ListApiConfigsResponse

Returns
Type	Description
void

listApiConfigs(request)

public listApiConfigs(request: google.cloud.apigateway.v1.IListApiConfigsRequest): Promise<google.cloud.apigateway.v1.ListApiConfigsResponse>;

Calls ListApiConfigs.

Parameter
Name	Description
request	IListApiConfigsRequest ListApiConfigsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.apigateway.v1.ListApiConfigsResponse>	Promise

listApis(request, callback)

public listApis(request: google.cloud.apigateway.v1.IListApisRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.ListApisCallback): void;

Calls ListApis.

Parameters
Name	Description
request	IListApisRequest ListApisRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.ListApisCallback Node-style callback called with the error, if any, and ListApisResponse

Returns
Type	Description
void

listApis(request)

public listApis(request: google.cloud.apigateway.v1.IListApisRequest): Promise<google.cloud.apigateway.v1.ListApisResponse>;

Calls ListApis.

Parameter
Name	Description
request	IListApisRequest ListApisRequest message or plain object

Returns
Type	Description
Promise<google.cloud.apigateway.v1.ListApisResponse>	Promise

listGateways(request, callback)

public listGateways(request: google.cloud.apigateway.v1.IListGatewaysRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.ListGatewaysCallback): void;

Calls ListGateways.

Parameters
Name	Description
request	IListGatewaysRequest ListGatewaysRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.ListGatewaysCallback Node-style callback called with the error, if any, and ListGatewaysResponse

Returns
Type	Description
void

listGateways(request)

public listGateways(request: google.cloud.apigateway.v1.IListGatewaysRequest): Promise<google.cloud.apigateway.v1.ListGatewaysResponse>;

Calls ListGateways.

Parameter
Name	Description
request	IListGatewaysRequest ListGatewaysRequest message or plain object

Returns
Type	Description
Promise<google.cloud.apigateway.v1.ListGatewaysResponse>	Promise

updateApi(request, callback)

public updateApi(request: google.cloud.apigateway.v1.IUpdateApiRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.UpdateApiCallback): void;

Calls UpdateApi.

Parameters
Name	Description
request	IUpdateApiRequest UpdateApiRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.UpdateApiCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateApi(request)

public updateApi(request: google.cloud.apigateway.v1.IUpdateApiRequest): Promise<google.longrunning.Operation>;

Calls UpdateApi.

Parameter
Name	Description
request	IUpdateApiRequest UpdateApiRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateApiConfig(request, callback)

public updateApiConfig(request: google.cloud.apigateway.v1.IUpdateApiConfigRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfigCallback): void;

Calls UpdateApiConfig.

Parameters
Name	Description
request	IUpdateApiConfigRequest UpdateApiConfigRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfigCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateApiConfig(request)

public updateApiConfig(request: google.cloud.apigateway.v1.IUpdateApiConfigRequest): Promise<google.longrunning.Operation>;

Calls UpdateApiConfig.

Parameter
Name	Description
request	IUpdateApiConfigRequest UpdateApiConfigRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateGateway(request, callback)

public updateGateway(request: google.cloud.apigateway.v1.IUpdateGatewayRequest, callback: google.cloud.apigateway.v1.ApiGatewayService.UpdateGatewayCallback): void;

Calls UpdateGateway.

Parameters
Name	Description
request	IUpdateGatewayRequest UpdateGatewayRequest message or plain object
callback	google.cloud.apigateway.v1.ApiGatewayService.UpdateGatewayCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateGateway(request)

public updateGateway(request: google.cloud.apigateway.v1.IUpdateGatewayRequest): Promise<google.longrunning.Operation>;

Calls UpdateGateway.

Parameter
Name	Description
request	IUpdateGatewayRequest UpdateGatewayRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise