Class protos.google.cloud.functions.v2.FunctionService (3.3.0)

Represents a FunctionService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.functions.v2.FunctionService

Package

@google-cloud/functions

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new FunctionService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

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

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

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

createFunction(request, callback)

public createFunction(request: google.cloud.functions.v2.ICreateFunctionRequest, callback: google.cloud.functions.v2.FunctionService.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.v2.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.v2.IDeleteFunctionRequest, callback: google.cloud.functions.v2.FunctionService.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.v2.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.v2.IGenerateDownloadUrlRequest, callback: google.cloud.functions.v2.FunctionService.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.v2.IGenerateDownloadUrlRequest): Promise<google.cloud.functions.v2.GenerateDownloadUrlResponse>;

Calls GenerateDownloadUrl.

Parameter
Name Description
request IGenerateDownloadUrlRequest

GenerateDownloadUrlRequest message or plain object
Returns
Type Description
Promise<google.cloud.functions.v2.GenerateDownloadUrlResponse>

Promise

generateUploadUrl(request, callback)

public generateUploadUrl(request: google.cloud.functions.v2.IGenerateUploadUrlRequest, callback: google.cloud.functions.v2.FunctionService.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.v2.IGenerateUploadUrlRequest): Promise<google.cloud.functions.v2.GenerateUploadUrlResponse>;

Calls GenerateUploadUrl.

Parameter
Name Description
request IGenerateUploadUrlRequest

GenerateUploadUrlRequest message or plain object
Returns
Type Description
Promise<google.cloud.functions.v2.GenerateUploadUrlResponse>

Promise

getFunction(request, callback)

public getFunction(request: google.cloud.functions.v2.IGetFunctionRequest, callback: google.cloud.functions.v2.FunctionService.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 Function
Returns
Type Description
void

getFunction(request)

public getFunction(request: google.cloud.functions.v2.IGetFunctionRequest): Promise<google.cloud.functions.v2.Function>;

Calls GetFunction.

Parameter
Name Description
request IGetFunctionRequest

GetFunctionRequest message or plain object
Returns
Type Description
Promise<google.cloud.functions.v2.Function>

Promise

listFunctions(request, callback)

public listFunctions(request: google.cloud.functions.v2.IListFunctionsRequest, callback: google.cloud.functions.v2.FunctionService.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.v2.IListFunctionsRequest): Promise<google.cloud.functions.v2.ListFunctionsResponse>;

Calls ListFunctions.

Parameter
Name Description
request IListFunctionsRequest

ListFunctionsRequest message or plain object
Returns
Type Description
Promise<google.cloud.functions.v2.ListFunctionsResponse>

Promise

listRuntimes(request, callback)

public listRuntimes(request: google.cloud.functions.v2.IListRuntimesRequest, callback: google.cloud.functions.v2.FunctionService.ListRuntimesCallback): void;

Calls ListRuntimes.

Parameters
Name Description
request IListRuntimesRequest

ListRuntimesRequest message or plain object
callback ListRuntimesCallback

Node-style callback called with the error, if any, and ListRuntimesResponse
Returns
Type Description
void

listRuntimes(request)

public listRuntimes(request: google.cloud.functions.v2.IListRuntimesRequest): Promise<google.cloud.functions.v2.ListRuntimesResponse>;

Calls ListRuntimes.

Parameter
Name Description
request IListRuntimesRequest

ListRuntimesRequest message or plain object
Returns
Type Description
Promise<google.cloud.functions.v2.ListRuntimesResponse>

Promise

updateFunction(request, callback)

public updateFunction(request: google.cloud.functions.v2.IUpdateFunctionRequest, callback: google.cloud.functions.v2.FunctionService.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.v2.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