Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Function

A function resource defines the code (Docker image) and configuration for a specific function. Functions are defined in applications. Avoid entering confidential information.

Properties

Optional applicationId

applicationId: undefined | string

The OCID of the application the function belongs to.

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment that contains the function.

Optional config

config: undefined | object

Function configuration. Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.

Example: {@code {\"MY_FUNCTION_CONFIG\": \"ConfVal\"}}

The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional displayName

displayName: undefined | string

The display name of the function. The display name is unique within the application containing the function.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the function.

Optional image

image: undefined | string

The qualified name of the Docker image to use in the function, including the image tag. The image should be in the OCI Registry that is in the same region as the function itself. Example: {@code phx.ocir.io/ten/functions/function:0.0.1}

Optional imageDigest

imageDigest: undefined | string

The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the OCI Registry will be used. Example: {@code sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7}

Optional invokeEndpoint

invokeEndpoint: undefined | string

The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the function.

Optional memoryInMBs

memoryInMBs: undefined | number

Maximum usable memory for the function (MiB). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional provisionedConcurrencyConfig

Optional shape

shape: Shape

The processor shape ({@code GENERIC_X86}/{@code GENERIC_ARM}) on which to run functions in the application, extracted from the image manifest.

Optional sourceDetails

sourceDetails: model.PreBuiltFunctionSourceDetails

Optional timeCreated

timeCreated: Date

The time the function was created, expressed in RFC 3339 timestamp format.

Example: {@code 2018-09-12T22:47:12.613Z}

Optional timeUpdated

timeUpdated: Date

The time the function was updated, expressed in RFC 3339 timestamp format.

Example: {@code 2018-09-12T22:47:12.613Z}

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

Timeout for executions of the function. Value in seconds. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional traceConfig

traceConfig: model.FunctionTraceConfig

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Function): object

getJsonObj