Class Function

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

Inheritance

object

Function

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.FunctionsService.Models

Assembly: OCI.DotNetSDK.Functions.dll

Syntax

public class Function

Properties

ApplicationId

Declaration

[JsonProperty(PropertyName = "applicationId")]
public string ApplicationId { get; set; }

Property Value

Type	Description
string	The OCID of the application the function belongs to.

CompartmentId

Declaration

[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment that contains the function.

Config

Declaration

[JsonProperty(PropertyName = "config")]
public Dictionary<string, string> Config { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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: {"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.

Type

Description

Dictionary<string, string>

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: {"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.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DetachedModeTimeoutInSeconds

Declaration

[JsonProperty(PropertyName = "detachedModeTimeoutInSeconds")]
public int? DetachedModeTimeoutInSeconds { get; set; }

Property Value

Type	Description
int?	Timeout for detached function invocations. Value in seconds. Example: {"detachedModeTimeoutInSeconds": 900}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

FailureDestination

Declaration

[JsonProperty(PropertyName = "failureDestination")]
public FailureDestinationDetails FailureDestination { get; set; }

Property Value

Type	Description
FailureDestinationDetails

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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: {"Department": "Finance"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the function.

Remarks

Required

Image

Declaration

[JsonProperty(PropertyName = "image")]
public string Image { get; set; }

Property Value

Type	Description
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: phx.ocir.io/ten/functions/function:0.0.1

ImageDigest

Declaration

[JsonProperty(PropertyName = "imageDigest")]
public string ImageDigest { get; set; }

Property Value

Type	Description
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: sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7

InvokeEndpoint

Declaration

[JsonProperty(PropertyName = "invokeEndpoint")]
public string InvokeEndpoint { get; set; }

Property Value

Type	Description
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.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Function.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Function.LifecycleStateEnum?	The current state of the function.

MemoryInMBs

Declaration

[JsonProperty(PropertyName = "memoryInMBs")]
public long? MemoryInMBs { get; set; }

Property Value

Type	Description
long?	Maximum usable memory for the function (MiB).

ProvisionedConcurrencyConfig

Declaration

[JsonProperty(PropertyName = "provisionedConcurrencyConfig")]
public FunctionProvisionedConcurrencyConfig ProvisionedConcurrencyConfig { get; set; }

Property Value

Type	Description
FunctionProvisionedConcurrencyConfig

Shape

Declaration

[JsonProperty(PropertyName = "shape")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Function.ShapeEnum? Shape { get; set; }

Property Value

Type	Description
Function.ShapeEnum?	The processor shape (`GENERIC_X86`/`GENERIC_ARM`) on which to run functions in the application, extracted from the image manifest.

SourceDetails

Declaration

[JsonProperty(PropertyName = "sourceDetails")]
public FunctionSourceDetails SourceDetails { get; set; }

Property Value

Type	Description
FunctionSourceDetails

SuccessDestination

Declaration

[JsonProperty(PropertyName = "successDestination")]
public SuccessDestinationDetails SuccessDestination { get; set; }

Property Value

Type	Description
SuccessDestinationDetails

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time the function was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time the function was updated, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

TimeoutInSeconds

Declaration

[JsonProperty(PropertyName = "timeoutInSeconds")]
public int? TimeoutInSeconds { get; set; }

Property Value

Type	Description
int?	Timeout for executions of the function. Value in seconds.

TraceConfig

Declaration

[JsonProperty(PropertyName = "traceConfig")]
public FunctionTraceConfig TraceConfig { get; set; }

Property Value

Type	Description
FunctionTraceConfig