ApiGatewayService - Documentation

Constructor

new ApiGatewayService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new ApiGatewayService service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

createApi(request, callback) → {undefined}

Calls CreateApi.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

createApi(request) → {Promise.<google.longrunning.Operation>}

Calls CreateApi.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.ICreateApiRequest	CreateApiRequest message or plain object

Returns:

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

createApiConfig(request, callback) → {undefined}

Calls CreateApiConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

createApiConfig(request) → {Promise.<google.longrunning.Operation>}

Calls CreateApiConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.ICreateApiConfigRequest	CreateApiConfigRequest message or plain object

Returns:

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

createGateway(request, callback) → {undefined}

Calls CreateGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

createGateway(request) → {Promise.<google.longrunning.Operation>}

Calls CreateGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.ICreateGatewayRequest	CreateGatewayRequest message or plain object

Returns:

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

deleteApi(request, callback) → {undefined}

Calls DeleteApi.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

deleteApi(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteApi.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IDeleteApiRequest	DeleteApiRequest message or plain object

Returns:

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

deleteApiConfig(request, callback) → {undefined}

Calls DeleteApiConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

deleteApiConfig(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteApiConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IDeleteApiConfigRequest	DeleteApiConfigRequest message or plain object

Returns:

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

deleteGateway(request, callback) → {undefined}

Calls DeleteGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

deleteGateway(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IDeleteGatewayRequest	DeleteGatewayRequest message or plain object

Returns:

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

getApi(request, callback) → {undefined}

Calls GetApi.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

getApi(request) → {Promise.<google.cloud.apigateway.v1.Api>}

Calls GetApi.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IGetApiRequest	GetApiRequest message or plain object

Returns:

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

getApiConfig(request, callback) → {undefined}

Calls GetApiConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

getApiConfig(request) → {Promise.<google.cloud.apigateway.v1.ApiConfig>}

Calls GetApiConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IGetApiConfigRequest	GetApiConfigRequest message or plain object

Returns:

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

getGateway(request, callback) → {undefined}

Calls GetGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

getGateway(request) → {Promise.<google.cloud.apigateway.v1.Gateway>}

Calls GetGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IGetGatewayRequest	GetGatewayRequest message or plain object

Returns:

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

listApiConfigs(request, callback) → {undefined}

Calls ListApiConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

listApiConfigs(request) → {Promise.<google.cloud.apigateway.v1.ListApiConfigsResponse>}

Calls ListApiConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IListApiConfigsRequest	ListApiConfigsRequest message or plain object

Returns:

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

listApis(request, callback) → {undefined}

Calls ListApis.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

listApis(request) → {Promise.<google.cloud.apigateway.v1.ListApisResponse>}

Calls ListApis.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IListApisRequest	ListApisRequest message or plain object

Returns:

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

listGateways(request, callback) → {undefined}

Calls ListGateways.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

listGateways(request) → {Promise.<google.cloud.apigateway.v1.ListGatewaysResponse>}

Calls ListGateways.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IListGatewaysRequest	ListGatewaysRequest message or plain object

Returns:

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

updateApi(request, callback) → {undefined}

Calls UpdateApi.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

updateApi(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateApi.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IUpdateApiRequest	UpdateApiRequest message or plain object

Returns:

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

updateApiConfig(request, callback) → {undefined}

Calls UpdateApiConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

updateApiConfig(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateApiConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IUpdateApiConfigRequest	UpdateApiConfigRequest message or plain object

Returns:

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

updateGateway(request, callback) → {undefined}

Calls UpdateGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.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
undefined

updateGateway(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateGateway.

Parameters:

Name	Type	Description
`request`	google.cloud.apigateway.v1.IUpdateGatewayRequest	UpdateGatewayRequest message or plain object

Returns:

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

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {ApiGatewayService}

Creates new ApiGatewayService service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

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

Type Definitions

CreateApiCallback(error, responseopt)

Callback as used by createApi.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateApiConfigCallback(error, responseopt)

Callback as used by createApiConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateGatewayCallback(error, responseopt)

Callback as used by createGateway.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteApiCallback(error, responseopt)

Callback as used by deleteApi.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteApiConfigCallback(error, responseopt)

Callback as used by deleteApiConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteGatewayCallback(error, responseopt)

Callback as used by deleteGateway.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

GetApiCallback(error, responseopt)

Callback as used by getApi.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.apigateway.v1.Api	<optional>	Api

GetApiConfigCallback(error, responseopt)

Callback as used by getApiConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.apigateway.v1.ApiConfig	<optional>	ApiConfig

GetGatewayCallback(error, responseopt)

Callback as used by getGateway.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.apigateway.v1.Gateway	<optional>	Gateway

ListApiConfigsCallback(error, responseopt)

Callback as used by listApiConfigs.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.apigateway.v1.ListApiConfigsResponse	<optional>	ListApiConfigsResponse

ListApisCallback(error, responseopt)

Callback as used by listApis.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.apigateway.v1.ListApisResponse	<optional>	ListApisResponse

ListGatewaysCallback(error, responseopt)

Callback as used by listGateways.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.apigateway.v1.ListGatewaysResponse	<optional>	ListGatewaysResponse

UpdateApiCallback(error, responseopt)

Callback as used by updateApi.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateApiConfigCallback(error, responseopt)

Callback as used by updateApiConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateGatewayCallback(error, responseopt)

Callback as used by updateGateway.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation