Class protos.google.cloud.functions.v1.CloudFunctionsService (3.3.0)

Represents a CloudFunctionsService

Inheritance

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

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new CloudFunctionsService service.

Parameters
Name	Description
`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
Name	Description
`request`	`ICallFunctionRequest` CallFunctionRequest message or plain object
`callback`	`CallFunctionCallback` Node-style callback called with the error, if any, and CallFunctionResponse

Returns
Type	Description
`void`

callFunction(request)

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

Calls CallFunction.

Parameter
Name	Description
`request`	`ICallFunctionRequest` CallFunctionRequest message or plain object

Returns
Type	Description
`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
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` Whether responses are length-delimited

Returns
Type	Description
`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
Name	Description
`request`	`ICreateFunctionRequest` CreateFunctionRequest message or plain object
`callback`	`CreateFunctionCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

createFunction(request)

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

Calls CreateFunction.

Parameter
Name	Description
`request`	`ICreateFunctionRequest` CreateFunctionRequest message or plain object

Returns
Type	Description
`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
Name	Description
`request`	`IDeleteFunctionRequest` DeleteFunctionRequest message or plain object
`callback`	`DeleteFunctionCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

deleteFunction(request)

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

Calls DeleteFunction.

Parameter
Name	Description
`request`	`IDeleteFunctionRequest` DeleteFunctionRequest message or plain object

Returns
Type	Description
`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
Name	Description
`request`	`IGenerateDownloadUrlRequest` GenerateDownloadUrlRequest message or plain object
`callback`	`GenerateDownloadUrlCallback` Node-style callback called with the error, if any, and GenerateDownloadUrlResponse

Returns
Type	Description
`void`

generateDownloadUrl(request)

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

Calls GenerateDownloadUrl.

Parameter
Name	Description
`request`	`IGenerateDownloadUrlRequest` GenerateDownloadUrlRequest message or plain object

Returns
Type	Description
`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
Name	Description
`request`	`IGenerateUploadUrlRequest` GenerateUploadUrlRequest message or plain object
`callback`	`GenerateUploadUrlCallback` Node-style callback called with the error, if any, and GenerateUploadUrlResponse

Returns
Type	Description
`void`

generateUploadUrl(request)

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

Calls GenerateUploadUrl.

Parameter
Name	Description
`request`	`IGenerateUploadUrlRequest` GenerateUploadUrlRequest message or plain object

Returns
Type	Description
`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
Name	Description
`request`	`IGetFunctionRequest` GetFunctionRequest message or plain object
`callback`	`GetFunctionCallback` Node-style callback called with the error, if any, and CloudFunction

Returns
Type	Description
`void`

getFunction(request)

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

Calls GetFunction.

Parameter
Name	Description
`request`	`IGetFunctionRequest` GetFunctionRequest message or plain object

Returns
Type	Description
`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
Name	Description
`request`	`IGetIamPolicyRequest` GetIamPolicyRequest message or plain object
`callback`	`GetIamPolicyCallback` Node-style callback called with the error, if any, and Policy

Returns
Type	Description
`void`

getIamPolicy(request)

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

Calls GetIamPolicy.

Parameter
Name	Description
`request`	`IGetIamPolicyRequest` GetIamPolicyRequest message or plain object

Returns
Type	Description
`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
Name	Description
`request`	`IListFunctionsRequest` ListFunctionsRequest message or plain object
`callback`	`ListFunctionsCallback` Node-style callback called with the error, if any, and ListFunctionsResponse

Returns
Type	Description
`void`

listFunctions(request)

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

Calls ListFunctions.

Parameter
Name	Description
`request`	`IListFunctionsRequest` ListFunctionsRequest message or plain object

Returns
Type	Description
`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
Name	Description
`request`	`ISetIamPolicyRequest` SetIamPolicyRequest message or plain object
`callback`	`SetIamPolicyCallback` Node-style callback called with the error, if any, and Policy

Returns
Type	Description
`void`

setIamPolicy(request)

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

Calls SetIamPolicy.

Parameter
Name	Description
`request`	`ISetIamPolicyRequest` SetIamPolicyRequest message or plain object

Returns
Type	Description
`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
Name	Description
`request`	`ITestIamPermissionsRequest` TestIamPermissionsRequest message or plain object
`callback`	`TestIamPermissionsCallback` Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns
Type	Description
`void`

testIamPermissions(request)

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

Calls TestIamPermissions.

Parameter
Name	Description
`request`	`ITestIamPermissionsRequest` TestIamPermissionsRequest message or plain object

Returns
Type	Description
`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
Name	Description
`request`	`IUpdateFunctionRequest` UpdateFunctionRequest message or plain object
`callback`	`UpdateFunctionCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

updateFunction(request)

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

Calls UpdateFunction.

Parameter
Name	Description
`request`	`IUpdateFunctionRequest` UpdateFunctionRequest message or plain object

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