Class protos.google.cloud.functions.v1.CloudFunctionsService

Represents a CloudFunctionsService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.functions.v1.CloudFunctionsService

Package

@google-cloud/functions

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new CloudFunctionsService service.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

callFunction(request, callback)

public callFunction(request: google.cloud.functions.v1.ICallFunctionRequest, callback: google.cloud.functions.v1.CloudFunctionsService.CallFunctionCallback): void;

Calls CallFunction.

Parameters
NameDescription
request ICallFunctionRequest

CallFunctionRequest message or plain object

callback google.cloud.functions.v1.CloudFunctionsService.CallFunctionCallback

Node-style callback called with the error, if any, and CallFunctionResponse

Returns
TypeDescription
void

callFunction(request)

public callFunction(request: google.cloud.functions.v1.ICallFunctionRequest): Promise<google.cloud.functions.v1.CallFunctionResponse>;

Calls CallFunction.

Parameter
NameDescription
request ICallFunctionRequest

CallFunctionRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.functions.v1.CallFunctionResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new CloudFunctionsService service using the specified rpc implementation.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
CloudFunctionsService

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

createFunction(request, callback)

public createFunction(request: google.cloud.functions.v1.ICreateFunctionRequest, callback: google.cloud.functions.v1.CloudFunctionsService.CreateFunctionCallback): void;

Calls CreateFunction.

Parameters
NameDescription
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

Returns
TypeDescription
void

createFunction(request)

public createFunction(request: google.cloud.functions.v1.ICreateFunctionRequest): Promise<google.longrunning.Operation>;

Calls CreateFunction.

Parameter
NameDescription
request google.cloud.functions.v1.ICreateFunctionRequest

CreateFunctionRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

deleteFunction(request, callback)

public deleteFunction(request: google.cloud.functions.v1.IDeleteFunctionRequest, callback: google.cloud.functions.v1.CloudFunctionsService.DeleteFunctionCallback): void;

Calls DeleteFunction.

Parameters
NameDescription
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

Returns
TypeDescription
void

deleteFunction(request)

public deleteFunction(request: google.cloud.functions.v1.IDeleteFunctionRequest): Promise<google.longrunning.Operation>;

Calls DeleteFunction.

Parameter
NameDescription
request google.cloud.functions.v1.IDeleteFunctionRequest

DeleteFunctionRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

generateDownloadUrl(request, callback)

public generateDownloadUrl(request: google.cloud.functions.v1.IGenerateDownloadUrlRequest, callback: google.cloud.functions.v1.CloudFunctionsService.GenerateDownloadUrlCallback): void;

Calls GenerateDownloadUrl.

Parameters
NameDescription
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

Returns
TypeDescription
void

generateDownloadUrl(request)

public generateDownloadUrl(request: google.cloud.functions.v1.IGenerateDownloadUrlRequest): Promise<google.cloud.functions.v1.GenerateDownloadUrlResponse>;

Calls GenerateDownloadUrl.

Parameter
NameDescription
request google.cloud.functions.v1.IGenerateDownloadUrlRequest

GenerateDownloadUrlRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.functions.v1.GenerateDownloadUrlResponse>

Promise

generateUploadUrl(request, callback)

public generateUploadUrl(request: google.cloud.functions.v1.IGenerateUploadUrlRequest, callback: google.cloud.functions.v1.CloudFunctionsService.GenerateUploadUrlCallback): void;

Calls GenerateUploadUrl.

Parameters
NameDescription
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

Returns
TypeDescription
void

generateUploadUrl(request)

public generateUploadUrl(request: google.cloud.functions.v1.IGenerateUploadUrlRequest): Promise<google.cloud.functions.v1.GenerateUploadUrlResponse>;

Calls GenerateUploadUrl.

Parameter
NameDescription
request google.cloud.functions.v1.IGenerateUploadUrlRequest

GenerateUploadUrlRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.functions.v1.GenerateUploadUrlResponse>

Promise

getFunction(request, callback)

public getFunction(request: google.cloud.functions.v1.IGetFunctionRequest, callback: google.cloud.functions.v1.CloudFunctionsService.GetFunctionCallback): void;

Calls GetFunction.

Parameters
NameDescription
request IGetFunctionRequest

GetFunctionRequest message or plain object

callback google.cloud.functions.v1.CloudFunctionsService.GetFunctionCallback

Node-style callback called with the error, if any, and CloudFunction

Returns
TypeDescription
void

getFunction(request)

public getFunction(request: google.cloud.functions.v1.IGetFunctionRequest): Promise<google.cloud.functions.v1.CloudFunction>;

Calls GetFunction.

Parameter
NameDescription
request IGetFunctionRequest

GetFunctionRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.functions.v1.CloudFunction>

Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.cloud.functions.v1.CloudFunctionsService.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters
NameDescription
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

Returns
TypeDescription
void

getIamPolicy(request)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls GetIamPolicy.

Parameter
NameDescription
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

Returns
TypeDescription
Promise<google.iam.v1.Policy>

Promise

listFunctions(request, callback)

public listFunctions(request: google.cloud.functions.v1.IListFunctionsRequest, callback: google.cloud.functions.v1.CloudFunctionsService.ListFunctionsCallback): void;

Calls ListFunctions.

Parameters
NameDescription
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

Returns
TypeDescription
void

listFunctions(request)

public listFunctions(request: google.cloud.functions.v1.IListFunctionsRequest): Promise<google.cloud.functions.v1.ListFunctionsResponse>;

Calls ListFunctions.

Parameter
NameDescription
request google.cloud.functions.v1.IListFunctionsRequest

ListFunctionsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.functions.v1.ListFunctionsResponse>

Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.cloud.functions.v1.CloudFunctionsService.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters
NameDescription
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

Returns
TypeDescription
void

setIamPolicy(request)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls SetIamPolicy.

Parameter
NameDescription
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

Returns
TypeDescription
Promise<google.iam.v1.Policy>

Promise

testIamPermissions(request, callback)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.cloud.functions.v1.CloudFunctionsService.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters
NameDescription
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

Returns
TypeDescription
void

testIamPermissions(request)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;

Calls TestIamPermissions.

Parameter
NameDescription
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

Returns
TypeDescription
Promise<google.iam.v1.TestIamPermissionsResponse>

Promise

updateFunction(request, callback)

public updateFunction(request: google.cloud.functions.v1.IUpdateFunctionRequest, callback: google.cloud.functions.v1.CloudFunctionsService.UpdateFunctionCallback): void;

Calls UpdateFunction.

Parameters
NameDescription
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

Returns
TypeDescription
void

updateFunction(request)

public updateFunction(request: google.cloud.functions.v1.IUpdateFunctionRequest): Promise<google.longrunning.Operation>;

Calls UpdateFunction.

Parameter
NameDescription
request google.cloud.functions.v1.IUpdateFunctionRequest

UpdateFunctionRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise