FunctionService

google .cloud .functions .v2. FunctionService

Represents a FunctionService

Constructor

new FunctionService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new FunctionService 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

createFunction(request, callback) → {undefined}

Calls CreateFunction.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.ICreateFunctionRequest	CreateFunctionRequest message or plain object
`callback`	google.cloud.functions.v2.FunctionService.CreateFunctionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls CreateFunction.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.ICreateFunctionRequest	CreateFunctionRequest message or plain object

Returns:

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

deleteFunction(request, callback) → {undefined}

Calls DeleteFunction.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IDeleteFunctionRequest	DeleteFunctionRequest message or plain object
`callback`	google.cloud.functions.v2.FunctionService.DeleteFunctionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls DeleteFunction.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IDeleteFunctionRequest	DeleteFunctionRequest message or plain object

Returns:

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

generateDownloadUrl(request, callback) → {undefined}

Calls GenerateDownloadUrl.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IGenerateDownloadUrlRequest	GenerateDownloadUrlRequest message or plain object
`callback`	google.cloud.functions.v2.FunctionService.GenerateDownloadUrlCallback	Node-style callback called with the error, if any, and GenerateDownloadUrlResponse

Returns:

Type	Description
undefined

generateDownloadUrl(request) → {Promise.<google.cloud.functions.v2.GenerateDownloadUrlResponse>}

Calls GenerateDownloadUrl.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IGenerateDownloadUrlRequest	GenerateDownloadUrlRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.functions.v2.GenerateDownloadUrlResponse>	Promise

generateUploadUrl(request, callback) → {undefined}

Calls GenerateUploadUrl.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IGenerateUploadUrlRequest	GenerateUploadUrlRequest message or plain object
`callback`	google.cloud.functions.v2.FunctionService.GenerateUploadUrlCallback	Node-style callback called with the error, if any, and GenerateUploadUrlResponse

Returns:

Type	Description
undefined

generateUploadUrl(request) → {Promise.<google.cloud.functions.v2.GenerateUploadUrlResponse>}

Calls GenerateUploadUrl.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IGenerateUploadUrlRequest	GenerateUploadUrlRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.functions.v2.GenerateUploadUrlResponse>	Promise

getFunction(request, callback) → {undefined}

Calls GetFunction.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IGetFunctionRequest	GetFunctionRequest message or plain object
`callback`	google.cloud.functions.v2.FunctionService.GetFunctionCallback	Node-style callback called with the error, if any, and Function

Returns:

Type	Description
undefined

getFunction(request) → {Promise.<google.cloud.functions.v2.Function>}

Calls GetFunction.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IGetFunctionRequest	GetFunctionRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.functions.v2.Function>	Promise

listFunctions(request, callback) → {undefined}

Calls ListFunctions.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IListFunctionsRequest	ListFunctionsRequest message or plain object
`callback`	google.cloud.functions.v2.FunctionService.ListFunctionsCallback	Node-style callback called with the error, if any, and ListFunctionsResponse

Returns:

Type	Description
undefined

listFunctions(request) → {Promise.<google.cloud.functions.v2.ListFunctionsResponse>}

Calls ListFunctions.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IListFunctionsRequest	ListFunctionsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.functions.v2.ListFunctionsResponse>	Promise

listRuntimes(request, callback) → {undefined}

Calls ListRuntimes.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IListRuntimesRequest	ListRuntimesRequest message or plain object
`callback`	google.cloud.functions.v2.FunctionService.ListRuntimesCallback	Node-style callback called with the error, if any, and ListRuntimesResponse

Returns:

Type	Description
undefined

listRuntimes(request) → {Promise.<google.cloud.functions.v2.ListRuntimesResponse>}

Calls ListRuntimes.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IListRuntimesRequest	ListRuntimesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.functions.v2.ListRuntimesResponse>	Promise

updateFunction(request, callback) → {undefined}

Calls UpdateFunction.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IUpdateFunctionRequest	UpdateFunctionRequest message or plain object
`callback`	google.cloud.functions.v2.FunctionService.UpdateFunctionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls UpdateFunction.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v2.IUpdateFunctionRequest	UpdateFunctionRequest message or plain object

Returns:

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

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

Creates new FunctionService 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
FunctionService	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateFunctionCallback(error, responseopt)

Callback as used by createFunction.

Parameters:

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

DeleteFunctionCallback(error, responseopt)

Callback as used by deleteFunction.

Parameters:

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

GenerateDownloadUrlCallback(error, responseopt)

Callback as used by generateDownloadUrl.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.functions.v2.GenerateDownloadUrlResponse	<optional>	GenerateDownloadUrlResponse

GenerateUploadUrlCallback(error, responseopt)

Callback as used by generateUploadUrl.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.functions.v2.GenerateUploadUrlResponse	<optional>	GenerateUploadUrlResponse

GetFunctionCallback(error, responseopt)

Callback as used by getFunction.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.functions.v2.Function	<optional>	Function

ListFunctionsCallback(error, responseopt)

Callback as used by listFunctions.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.functions.v2.ListFunctionsResponse	<optional>	ListFunctionsResponse

ListRuntimesCallback(error, responseopt)

Callback as used by listRuntimes.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.functions.v2.ListRuntimesResponse	<optional>	ListRuntimesResponse

UpdateFunctionCallback(error, responseopt)

Callback as used by updateFunction.

Parameters:

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