CloudFunctionsService - Documentation

Constructor

new CloudFunctionsService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

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

Creates new CloudFunctionsService 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

callFunction(request, callback) → {undefined}

Calls CallFunction.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v1.ICallFunctionRequest	CallFunctionRequest message or plain object
`callback`	google.cloud.functions.v1.CloudFunctionsService.CallFunctionCallback	Node-style callback called with the error, if any, and CallFunctionResponse

callFunction(request) → {Promise.<google.cloud.functions.v1.CallFunctionResponse>}

Calls CallFunction.

Parameters:

Name	Type	Description
`request`	google.cloud.functions.v1.ICallFunctionRequest	CallFunctionRequest message or plain object

createFunction(request, callback) → {undefined}

Calls CreateFunction.

Parameters:

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

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

Calls CreateFunction.

Parameters:

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

deleteFunction(request, callback) → {undefined}

Calls DeleteFunction.

Parameters:

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

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

Calls DeleteFunction.

Parameters:

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

generateDownloadUrl(request, callback) → {undefined}

Calls GenerateDownloadUrl.

Parameters:

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

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

Calls GenerateDownloadUrl.

Parameters:

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

generateUploadUrl(request, callback) → {undefined}

Calls GenerateUploadUrl.

Parameters:

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

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

Calls GenerateUploadUrl.

Parameters:

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

getFunction(request, callback) → {undefined}

Calls GetFunction.

Parameters:

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

getFunction(request) → {Promise.<google.cloud.functions.v1.CloudFunction>}

Calls GetFunction.

Parameters:

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

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.IGetIamPolicyRequest	GetIamPolicyRequest message or plain object
`callback`	google.cloud.functions.v1.CloudFunctionsService.GetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.IGetIamPolicyRequest	GetIamPolicyRequest message or plain object

listFunctions(request, callback) → {undefined}

Calls ListFunctions.

Parameters:

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

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

Calls ListFunctions.

Parameters:

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

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ISetIamPolicyRequest	SetIamPolicyRequest message or plain object
`callback`	google.cloud.functions.v1.CloudFunctionsService.SetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ISetIamPolicyRequest	SetIamPolicyRequest message or plain object

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ITestIamPermissionsRequest	TestIamPermissionsRequest message or plain object
`callback`	google.cloud.functions.v1.CloudFunctionsService.TestIamPermissionsCallback	Node-style callback called with the error, if any, and TestIamPermissionsResponse

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ITestIamPermissionsRequest	TestIamPermissionsRequest message or plain object

updateFunction(request, callback) → {undefined}

Calls UpdateFunction.

Parameters:

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

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

Calls UpdateFunction.

Parameters:

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

Type Definitions

CallFunctionCallback(error, responseopt)

Callback as used by google.cloud.functions.v1.CloudFunctionsService#callFunction.

Parameters:

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

CreateFunctionCallback(error, responseopt)

Callback as used by google.cloud.functions.v1.CloudFunctionsService#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 google.cloud.functions.v1.CloudFunctionsService#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 google.cloud.functions.v1.CloudFunctionsService#generateDownloadUrl.

Parameters:

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

GenerateUploadUrlCallback(error, responseopt)

Callback as used by google.cloud.functions.v1.CloudFunctionsService#generateUploadUrl.

Parameters:

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

GetFunctionCallback(error, responseopt)

Callback as used by google.cloud.functions.v1.CloudFunctionsService#getFunction.

Parameters:

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

GetIamPolicyCallback(error, responseopt)

Callback as used by google.cloud.functions.v1.CloudFunctionsService#getIamPolicy.

Parameters:

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

ListFunctionsCallback(error, responseopt)

Callback as used by google.cloud.functions.v1.CloudFunctionsService#listFunctions.

Parameters:

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

SetIamPolicyCallback(error, responseopt)

Callback as used by google.cloud.functions.v1.CloudFunctionsService#setIamPolicy.

Parameters:

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

TestIamPermissionsCallback(error, responseopt)

Callback as used by google.cloud.functions.v1.CloudFunctionsService#testIamPermissions.

Parameters:

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

UpdateFunctionCallback(error, responseopt)

Callback as used by google.cloud.functions.v1.CloudFunctionsService#updateFunction.

Parameters:

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