Show / Hide Table of Contents

Namespace Oci.FunctionsService.Models

Classes

Application

An application contains functions and defined attributes shared between those functions, such as network configuration and configuration. Avoid entering confidential information.

ApplicationLoggingConfig

Set logging configuration for an application. This is only used if Service Logs for the application are enabled in the OCI Logging service.

ApplicationSummary

Summary of an application.

ApplicationTraceConfig

Define the tracing configuration for an application.

ArchiveFunctionSourceDetails

Object capturing fields required for creating an archive based function.

ArchiveSourceDetails

The details for the Archive source of the Function. This mode is used when the function code is provided as an archive, either from Object Storage or directly uploaded by the API caller. It is suitable for scenarios where the function code is packaged as a single archive file.

ArchiveSourceDetailsModelConverter

ChangeApplicationCompartmentDetails

Properties to change the compartment of an application.

ConfigDetails

Details about the required and optional Function configurations needed for proper performance of the PBF.

ConstantProvisionedConcurrencyConfig

Configuration specifying a constant amount of provisioned concurrency.

ContainerImageFunctionSourceDetails

Source details of a container image based function.

CreateApplicationDetails

Properties for a new application.

CreateArchiveFunctionSourceDetails

Source details for creating an archive\u2011based function.

CreateArchiveSourceDetails

The details required to create an Archive-based function source. This mode is used when the function code is provided as an archive, either from Object Storage or directly uploaded by the API caller. It is suitable for scenarios where the function code is packaged as a single archive file.

CreateArchiveSourceDetailsModelConverter

CreateContainerImageFunctionSourceDetails

Source details for creating a container image based function.

CreateDirectArchiveSourceDetails

Source details for creating the archive based function from Direct Archive. This allows the API caller to directly upload the function code as a base64-encoded archive file. It is useful when the caller wants to provide the code inline during function creation.

CreateFunctionDetails

Properties to create a new function.

CreateFunctionSourceDetails

The source details for creating the Function. The function can be created from various sources.

CreateFunctionSourceDetailsModelConverter

CreateFunctionUpdateRuntimeConfig

FunctionsRuntime configuration for creating a function with 'FUNCTION_UPDATE' Runtime Update strategy.

CreateManualRuntimeConfig

FunctionsRuntime configuration for creating a function with 'MANUAL' Runtime Update strategy.

CreateObjectStorageArchiveSourceDetails

Source details for creating the archive based function from Object Storage. This is used when the function code is stored in Object Storage. It is suitable for scenarios where the function code is uploaded as an archive file to a specific bucket and namespace

CreatePreBuiltFunctionSourceDetails

Source details for creating a function from a Pre\u2011Built Functions listing (PbfListing).

CreateRuntimeConfig

FunctionsRuntime configuration used to create a function.

CreateRuntimeConfigModelConverter

DirectArchiveSourceDetails

The details for the Archive source of the Function from Direct Archive. This allows the API caller to directly upload the function code as a base64-encoded archive file. It is useful when the caller wants to provide the code inline during function creation.

FailureDestinationDetails

An object that represents the destination to which Oracle Functions will send an invocation record with the details of the error of the failed detached function invocation. A notification is an example of a failure destination.
Example: {"kind": "NOTIFICATION", "topicId": "topic_OCID"}

FailureDestinationDetailsModelConverter

Function

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

FunctionProvisionedConcurrencyConfig

Define the strategy for provisioned concurrency for the function.

FunctionProvisionedConcurrencyConfigModelConverter

FunctionSourceDetails

The source details for the Function. The function can be created from various sources.

FunctionSourceDetailsModelConverter

FunctionSummary

Summary of a function.

FunctionTraceConfig

Define the tracing configuration for a function.

FunctionUpdateRuntimeConfig

FunctionsRuntime configuration for a function with 'FUNCTION_UPDATE' Runtime Update strategy.

FunctionsRuntime

FunctionsRuntime resources provide details about the available runtimes for consumption by the user. This resource contains details about the runtimes supported language and os etc.

FunctionsRuntimeCollection

Results of a FunctionsRuntime search. Contains FunctionsRuntimeSummary items.

FunctionsRuntimeSummary

Summary of the FunctionsRuntime.

FunctionsRuntimeVersion

This represents a version of a FunctionsRuntime. Each new functional update to a FunctionsRuntime from the Functions team will change the image that will result in the creation of new FunctionsRuntimeVersion resource creation. This is a sub-resource of a FunctionsRuntime.

FunctionsRuntimeVersionCollection

Results of a FunctionsRuntimeVersion search. Contains FunctionsRuntimeVersionSummary items.

FunctionsRuntimeVersionSummary

Summary of the FunctionsRuntimeVersion.

ImagePolicyConfig

Define the image signature verification policy for an application.

KeyDetails

The properties that define the kms keys used by Functions for Image Signature verification.

ManualRuntimeConfig

FunctionsRuntime configuration for a function with 'MANUAL' Runtime Update strategy.

NoneFailureDestinationDetails

Specifies no failure destination
Example: {"kind": "NONE"}

NoneProvisionedConcurrencyConfig

Configuration specifying no provisioned concurrency

NoneSuccessDestinationDetails

Specifies no success destination
Example: {"kind": "NONE"}

NotificationFailureDestinationDetails

The destination topic in the Notifications service to which to send the response of the failed detached function invocation.
Example: {"kind": "NOTIFICATION", "topicId": "topic_OCID"}

NotificationSuccessDestinationDetails

The destination topic in the Notifications service to which to send the response of the successful detached function invocation.
Example: {"kind": "NOTIFICATION", "topicId": "topic_OCID"}

ObjectStorageArchiveSourceDetails

The details for the Archive source of the Function from Object Storage. This is used when the function code is stored in Object Storage. It is suitable for scenarios where the function code is uploaded as an archive file to a specific bucket and namespace

PbfListing

PbfListing resources provide details about the available PBFs for consumption by the user. This resource contains details about PBF's functionality, policies required, configuration parameters expected etc.

PbfListingSummary

Summary of the PbfListing.

PbfListingVersion

This represents a version of a PbfListing. Each new update from the publisher or the change in the image will result in the creation of new PbfListingVersion resource creation. This is a sub-resource of a PbfListing.

PbfListingVersionSummary

Summary of the PbfListingVersion.

PbfListingVersionsCollection

Results of a PbfListingVersion search. Contains both PbfListingVersionSummary items and other information, such as metadata.

PbfListingsCollection

Results of a PbfListing search. Contains boh PbfListingSummary items and other information, such as metadata.

PolicyDetails

A policy required for this PBF execution.

PreBuiltFunctionSourceDetails

The source of the Function which is based on a Pre-Built Function Listing (PbfListing).

PublisherDetails

Contains details about the publisher of this PBF Listing.

QueueFailureDestinationDetails

The destination queue or channel in the Queue service to which to send the response of the failed detached function invocation.
Example: {"kind": "QUEUE", "queueId": "queue_OCID", "channelId": "channel_Id"}

QueueSuccessDestinationDetails

The destination queue or channel in the Queue service to which to send the response of the successful detached function invocation.
Example: {"kind": "QUEUE", "queueId": "queue_OCID", "channelId": "channel_Id"}

RequirementDetails

Minimum memory required by this PBF. The user should use memory greater than or equal to this value while configuring the Function.

RuntimeConfig

FunctionsRuntime configuration for a function.

RuntimeConfigModelConverter

StreamFailureDestinationDetails

The destination stream in the Streaming service to which to send the response of the failed detached function invocation.
Example: {"kind": "STREAM", "streamId": "stream_OCID"}

StreamSuccessDestinationDetails

The destination stream in the Streaming service to which to send the response of the successful detached function invocation.
Example: {"kind": "STREAM", "streamId": "stream_OCID"}

SuccessDestinationDetails

An object that represents the destination to which Oracle Functions will send an invocation record with the details of the successful detached function invocation. A stream is an example of a success destination.
Example: {"kind": "STREAM", "streamId": "stream_OCID"}

SuccessDestinationDetailsModelConverter

Trigger

PBF specific triggers for activating a PBF.

TriggerSummary

Summary of the Trigger.

TriggersCollection

Results of a Trigger search. Contains boh TriggerSummary items and other information, such as metadata.

UpdateApplicationDetails

Properties to update an application.

UpdateArchiveFunctionSourceDetails

Source details for updating an archive\u2011based function.

UpdateArchiveSourceDetails

Source details for updating an archive\u2011based function.

UpdateArchiveSourceDetailsModelConverter

UpdateContainerImageFunctionSourceDetails

Source details for updating a container image based function.

UpdateDirectArchiveSourceDetails

Source details required for updating an archive based function from Direct Archive.

UpdateFunctionDetails

Updates attributes of a function.

UpdateFunctionSourceDetails

The source details for updating the Function.

UpdateFunctionSourceDetailsModelConverter

UpdateFunctionUpdateRuntimeConfig

FunctionsRuntime configuration for updating a function with 'FUNCTION_UPDATE' Runtime Update strategy.

UpdateManualRuntimeConfig

FunctionsRuntime configuration for updating a function with 'MANUAL' Runtime Update strategy.

UpdateObjectStorageArchiveSourceDetails

Source details required for updating an archive based function from Object Storage.

UpdateRuntimeConfig

FunctionsRuntime configuration used to update a function.

UpdateRuntimeConfigModelConverter

WorkRequest

An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.

WorkRequestError

An error encountered while performing an operation that is tracked by a work request.

WorkRequestErrorCollection

A list of work request errors. Can contain both errors and other information, such as metadata.

WorkRequestLogEntry

A log message from performing an operation that is tracked by a work request.

WorkRequestLogEntryCollection

A list of work request logs. Can contain both logs and other information, such as metadata.

WorkRequestResource

A resource created or operated on by a work request.

WorkRequestSummary

Summary information about an asynchronous work request.

WorkRequestSummaryCollection

A list of work requests. Can contain both work requests and other information, such as metadata.

Enums

ActionType

Possible types of actions.

Application.LifecycleStateEnum

Application.ShapeEnum

ApplicationLoggingConfig.LineFormatEnum

ApplicationSummary.ShapeEnum

ArchiveSourceDetails.ArchiveSourceTypeEnum

CreateApplicationDetails.ShapeEnum

CreateArchiveSourceDetails.ArchiveSourceTypeEnum

CreateFunctionSourceDetails.SourceTypeEnum

CreateRuntimeConfig.RuntimeConfigTypeEnum

FailureDestinationDetails.KindEnum

Function.LifecycleStateEnum

Function.ShapeEnum

FunctionProvisionedConcurrencyConfig.StrategyEnum

FunctionSourceDetails.SourceTypeEnum

FunctionSummary.ShapeEnum

FunctionsRuntime.LifecycleStateEnum

FunctionsRuntimeVersion.LifecycleStateEnum

FunctionsRuntimeVersion.SupportedArchitecturesEnum

FunctionsRuntimeVersionSummary.SupportedArchitecturesEnum

OperationStatus

The status of the work request.

OperationType

The asynchronous operation tracked by the work request.

PbfListing.LifecycleStateEnum

PbfListingVersion.LifecycleStateEnum

RuntimeConfig.RuntimeConfigTypeEnum

SuccessDestinationDetails.KindEnum

UpdateArchiveSourceDetails.ArchiveSourceTypeEnum

UpdateFunctionSourceDetails.SourceTypeEnum

UpdateRuntimeConfig.RuntimeConfigTypeEnum

WorkRequestResourceMetadataKey

Possible metadata keys for work request resource metadata.

In this article
Back to top