A service that application uses to manipulate triggers and functions. v1
Package
@google-cloud/functions!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of CloudFunctionsServiceClient.
Parameter
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
Property Value
Type | Description |
gax.GoogleAuth | |
cloudFunctionsServiceStub
cloudFunctionsServiceStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
{
[name: string]: Function;
} | |
operationsClient
operationsClient: gax.OperationsClient;
Property Value
Type | Description |
gax.OperationsClient | |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
Property Value
Type | Description |
{
[name: string]: gax.PathTemplate;
} | |
port
static get port(): number;
The port for this API service.
Property Value
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
warn
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
(code: string, message: string, warnType?: string) => void | |
Methods
callFunction(request, options)
callFunction(request?: protos.google.cloud.functions.v1.ICallFunctionRequest, options?: CallOptions): Promise<[protos.google.cloud.functions.v1.ICallFunctionResponse, protos.google.cloud.functions.v1.ICallFunctionRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.ICallFunctionRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.functions.v1.ICallFunctionResponse, protos.google.cloud.functions.v1.ICallFunctionRequest | undefined, {} | undefined]> | |
callFunction(request, options, callback)
callFunction(request: protos.google.cloud.functions.v1.ICallFunctionRequest, options: CallOptions, callback: Callback<protos.google.cloud.functions.v1.ICallFunctionResponse, protos.google.cloud.functions.v1.ICallFunctionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.ICallFunctionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.functions.v1.ICallFunctionResponse, protos.google.cloud.functions.v1.ICallFunctionRequest | null | undefined, {} | null | undefined>
|
Returns
callFunction(request, callback)
callFunction(request: protos.google.cloud.functions.v1.ICallFunctionRequest, callback: Callback<protos.google.cloud.functions.v1.ICallFunctionResponse, protos.google.cloud.functions.v1.ICallFunctionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.ICallFunctionRequest
|
callback |
Callback<protos.google.cloud.functions.v1.ICallFunctionResponse, protos.google.cloud.functions.v1.ICallFunctionRequest | null | undefined, {} | null | undefined>
|
Returns
checkCreateFunctionProgress(name)
checkCreateFunctionProgress(name: string): Promise<LROperation<protos.google.cloud.functions.v1.CloudFunction, protos.google.cloud.functions.v1.OperationMetadataV1>>;
Check the status of the long running operation returned by createFunction()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.functions.v1.CloudFunction, protos.google.cloud.functions.v1.OperationMetadataV1>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkDeleteFunctionProgress(name)
checkDeleteFunctionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.functions.v1.OperationMetadataV1>>;
Check the status of the long running operation returned by deleteFunction()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.functions.v1.OperationMetadataV1>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkUpdateFunctionProgress(name)
checkUpdateFunctionProgress(name: string): Promise<LROperation<protos.google.cloud.functions.v1.CloudFunction, protos.google.cloud.functions.v1.OperationMetadataV1>>;
Check the status of the long running operation returned by updateFunction()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.functions.v1.CloudFunction, protos.google.cloud.functions.v1.OperationMetadataV1>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed.
|
cloudFunctionPath(project, location, function_)
cloudFunctionPath(project: string, location: string, function_: string): string;
Return a fully-qualified cloudFunction resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
function_ |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
createFunction(request, options)
createFunction(request?: protos.google.cloud.functions.v1.ICreateFunctionRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.ICreateFunctionRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
createFunction(request, options, callback)
createFunction(request: protos.google.cloud.functions.v1.ICreateFunctionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.ICreateFunctionRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
createFunction(request, callback)
createFunction(request: protos.google.cloud.functions.v1.ICreateFunctionRequest, callback: Callback<LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.ICreateFunctionRequest
|
callback |
Callback<LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteFunction(request, options)
deleteFunction(request?: protos.google.cloud.functions.v1.IDeleteFunctionRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IDeleteFunctionRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
deleteFunction(request, options, callback)
deleteFunction(request: protos.google.cloud.functions.v1.IDeleteFunctionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IDeleteFunctionRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteFunction(request, callback)
deleteFunction(request: protos.google.cloud.functions.v1.IDeleteFunctionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IDeleteFunctionRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
generateDownloadUrl(request, options)
generateDownloadUrl(request?: protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest, options?: CallOptions): Promise<[protos.google.cloud.functions.v1.IGenerateDownloadUrlResponse, protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.functions.v1.IGenerateDownloadUrlResponse, protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest | undefined, {} | undefined]> | |
generateDownloadUrl(request, options, callback)
generateDownloadUrl(request: protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest, options: CallOptions, callback: Callback<protos.google.cloud.functions.v1.IGenerateDownloadUrlResponse, protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.functions.v1.IGenerateDownloadUrlResponse, protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest | null | undefined, {} | null | undefined>
|
Returns
generateDownloadUrl(request, callback)
generateDownloadUrl(request: protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest, callback: Callback<protos.google.cloud.functions.v1.IGenerateDownloadUrlResponse, protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest
|
callback |
Callback<protos.google.cloud.functions.v1.IGenerateDownloadUrlResponse, protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest | null | undefined, {} | null | undefined>
|
Returns
generateUploadUrl(request, options)
generateUploadUrl(request?: protos.google.cloud.functions.v1.IGenerateUploadUrlRequest, options?: CallOptions): Promise<[protos.google.cloud.functions.v1.IGenerateUploadUrlResponse, protos.google.cloud.functions.v1.IGenerateUploadUrlRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IGenerateUploadUrlRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.functions.v1.IGenerateUploadUrlResponse, protos.google.cloud.functions.v1.IGenerateUploadUrlRequest | undefined, {} | undefined]> | |
generateUploadUrl(request, options, callback)
generateUploadUrl(request: protos.google.cloud.functions.v1.IGenerateUploadUrlRequest, options: CallOptions, callback: Callback<protos.google.cloud.functions.v1.IGenerateUploadUrlResponse, protos.google.cloud.functions.v1.IGenerateUploadUrlRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IGenerateUploadUrlRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.functions.v1.IGenerateUploadUrlResponse, protos.google.cloud.functions.v1.IGenerateUploadUrlRequest | null | undefined, {} | null | undefined>
|
Returns
generateUploadUrl(request, callback)
generateUploadUrl(request: protos.google.cloud.functions.v1.IGenerateUploadUrlRequest, callback: Callback<protos.google.cloud.functions.v1.IGenerateUploadUrlResponse, protos.google.cloud.functions.v1.IGenerateUploadUrlRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IGenerateUploadUrlRequest
|
callback |
Callback<protos.google.cloud.functions.v1.IGenerateUploadUrlResponse, protos.google.cloud.functions.v1.IGenerateUploadUrlRequest | null | undefined, {} | null | undefined>
|
Returns
getFunction(request, options)
getFunction(request?: protos.google.cloud.functions.v1.IGetFunctionRequest, options?: CallOptions): Promise<[protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IGetFunctionRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IGetFunctionRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IGetFunctionRequest | undefined, {} | undefined]> | |
getFunction(request, options, callback)
getFunction(request: protos.google.cloud.functions.v1.IGetFunctionRequest, options: CallOptions, callback: Callback<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IGetFunctionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IGetFunctionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IGetFunctionRequest | null | undefined, {} | null | undefined>
|
Returns
getFunction(request, callback)
getFunction(request: protos.google.cloud.functions.v1.IGetFunctionRequest, callback: Callback<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IGetFunctionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IGetFunctionRequest
|
callback |
Callback<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IGetFunctionRequest | null | undefined, {} | null | undefined>
|
Returns
getIamPolicy(request, options)
getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.iam.v1.IGetIamPolicyRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]> | |
getIamPolicy(request, options, callback)
getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.IGetIamPolicyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns
getIamPolicy(request, callback)
getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.IGetIamPolicyRequest
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
listFunctions(request, options)
listFunctions(request?: protos.google.cloud.functions.v1.IListFunctionsRequest, options?: CallOptions): Promise<[protos.google.cloud.functions.v1.ICloudFunction[], protos.google.cloud.functions.v1.IListFunctionsRequest | null, protos.google.cloud.functions.v1.IListFunctionsResponse]>;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IListFunctionsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.functions.v1.ICloudFunction[], protos.google.cloud.functions.v1.IListFunctionsRequest | null, protos.google.cloud.functions.v1.IListFunctionsResponse]> | |
listFunctions(request, options, callback)
listFunctions(request: protos.google.cloud.functions.v1.IListFunctionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.functions.v1.IListFunctionsRequest, protos.google.cloud.functions.v1.IListFunctionsResponse | null | undefined, protos.google.cloud.functions.v1.ICloudFunction>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IListFunctionsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.functions.v1.IListFunctionsRequest, protos.google.cloud.functions.v1.IListFunctionsResponse | null | undefined, protos.google.cloud.functions.v1.ICloudFunction>
|
Returns
listFunctions(request, callback)
listFunctions(request: protos.google.cloud.functions.v1.IListFunctionsRequest, callback: PaginationCallback<protos.google.cloud.functions.v1.IListFunctionsRequest, protos.google.cloud.functions.v1.IListFunctionsResponse | null | undefined, protos.google.cloud.functions.v1.ICloudFunction>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IListFunctionsRequest
|
callback |
PaginationCallback<protos.google.cloud.functions.v1.IListFunctionsRequest, protos.google.cloud.functions.v1.IListFunctionsResponse | null | undefined, protos.google.cloud.functions.v1.ICloudFunction>
|
Returns
listFunctionsAsync(request, options)
listFunctionsAsync(request?: protos.google.cloud.functions.v1.IListFunctionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.functions.v1.ICloudFunction>;
Equivalent to listFunctions
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IListFunctionsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.functions.v1.ICloudFunction> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [CloudFunction]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listFunctionsStream(request, options)
listFunctionsStream(request?: protos.google.cloud.functions.v1.IListFunctionsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IListFunctionsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [CloudFunction] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listFunctionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
locationPath(project, location)
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
matchFunctionFromCloudFunctionName(cloudFunctionName)
matchFunctionFromCloudFunctionName(cloudFunctionName: string): string | number;
Parse the function from CloudFunction resource.
Parameter
Name | Description |
cloudFunctionName |
string
A fully-qualified path representing CloudFunction resource.
|
Returns
Type | Description |
string | number | {string} A string representing the function.
|
matchLocationFromCloudFunctionName(cloudFunctionName)
matchLocationFromCloudFunctionName(cloudFunctionName: string): string | number;
Parse the location from CloudFunction resource.
Parameter
Name | Description |
cloudFunctionName |
string
A fully-qualified path representing CloudFunction resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchProjectFromCloudFunctionName(cloudFunctionName)
matchProjectFromCloudFunctionName(cloudFunctionName: string): string | number;
Parse the project from CloudFunction resource.
Parameter
Name | Description |
cloudFunctionName |
string
A fully-qualified path representing CloudFunction resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
setIamPolicy(request, options)
setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.iam.v1.ISetIamPolicyRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]> | |
setIamPolicy(request, options, callback)
setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.ISetIamPolicyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns
setIamPolicy(request, callback)
setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.ISetIamPolicyRequest
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns
testIamPermissions(request, options)
testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.iam.v1.ITestIamPermissionsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]> | |
testIamPermissions(request, options, callback)
testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.ITestIamPermissionsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
|
Returns
testIamPermissions(request, callback)
testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.ITestIamPermissionsRequest
|
callback |
Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
|
Returns
updateFunction(request, options)
updateFunction(request?: protos.google.cloud.functions.v1.IUpdateFunctionRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IUpdateFunctionRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
updateFunction(request, options, callback)
updateFunction(request: protos.google.cloud.functions.v1.IUpdateFunctionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IUpdateFunctionRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
updateFunction(request, callback)
updateFunction(request: protos.google.cloud.functions.v1.IUpdateFunctionRequest, callback: Callback<LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.functions.v1.IUpdateFunctionRequest
|
callback |
Callback<LROperation<protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns