CallableOptions extension type
Options that can be set on a callable HTTPS function.
- on
- Implemented types
- Available extensions
Constructors
- CallableOptions({JSAny? omit, JSAny? region, JSAny? cors, JSAny? memory, JSAny? timeoutSeconds, JSAny? minInstances, JSAny? maxInstances, JSAny? concurrency, JSAny? cpu, JSAny? vpcConnector, JSAny? vpcConnectorEgressSettings, JSAny? serviceAccount, JSAny? ingressSettings, JSAny? labels, JSAny? secrets, JSAny? invoker, JSAny? enforceAppCheck, JSAny? consumeAppCheckToken})
- Constructor
Properties
- concurrency → JSAny?
-
Number of requests a function can serve at once.
no setterinherited
- consumeAppCheckToken → bool?
-
Determines whether Firebase App Check token is consumed on request. Defaults to false.
no setter
- cors → JSAny?
-
If true, allows CORS on requests to this function.
If this is a
stringorRegExp, allows requests from domains that match the provided value. If this is anArray, allows requests from domains matching at least one entry of the array. Defaults to true for {@link https.CallableFunction} and false otherwise.no setterinherited - cpu → JSAny?
-
Fractional number of CPUs to allocate to a function.
no setterinherited
- enforceAppCheck → bool?
-
Determines whether Firebase AppCheck is enforced.
When true, requests with invalid tokens autorespond with a 401
(Unauthorized) error.
When false, requests with invalid tokens set event.app to undefiend.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- ingressSettings → JSAny?
-
Ingress settings which control where this function can be called from.
no setterinherited
- invoker → JSAny?
-
Invoker to set access control on https functions.
no setterinherited
- labels → JSAny?
-
User labels to set on the function.
no setterinherited
- maxInstances → JSAny?
-
Max number of instances to be running in parallel.
no setterinherited
- memory → JSAny?
-
Amount of memory to allocate to a function.
no setterinherited
- minInstances → JSAny?
-
Min number of actual instances to be running at a given time.
no setterinherited
- omit → JSAny?
-
If true, do not deploy or emulate this function.
no setterinherited
- region → JSAny?
-
HTTP functions can override global options and can specify multiple regions to deploy to.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- secrets → JSAny?
-
Secrets to bind to a function.
no setterinherited
- serviceAccount → JSAny?
-
Specific service account for the function to run as.
no setterinherited
- timeoutSeconds → JSAny?
-
Timeout for the function in seconds, possible values are 0 to 540.
HTTPS functions can specify a higher timeout.
no setterinherited
- vpcConnector → JSAny?
-
Connect cloud function to specified VPC connector.
no setterinherited
- vpcConnectorEgressSettings → JSAny?
-
Egress settings for VPC connector.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited