Functions Management Functions

CHANGE_APPLICATION_COMPARTMENT Function

Moves an application into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources Between Compartments.

Syntax

FUNCTION change_application_compartment (
  application_id varchar2,
  change_application_compartment_details dbms_cloud_oci_functions_change_application_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_change_application_compartment_response_t;

Parameters

Parameter	Description
`application_id`	(required) The OCID of this application.
`change_application_compartment_details`	(required) Properties to change the compartment of an application.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_APPLICATION Function

Creates a new application.

Syntax

FUNCTION create_application (
  create_application_details dbms_cloud_oci_functions_create_application_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_create_application_response_t;

Parameters

Parameter	Description
`create_application_details`	(required) Specification of the application to create
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_FUNCTION Function

Creates a new function.

Syntax

FUNCTION create_function (
  create_function_details dbms_cloud_oci_functions_create_function_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_create_function_response_t;

Parameters

Parameter	Description
`create_function_details`	(required) Specification of the function to create
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_APPLICATION Function

Deletes an application.

Syntax

FUNCTION delete_application (
  application_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_delete_application_response_t;

Parameters

Parameter	Description
`application_id`	(required) The OCID of this application.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_FUNCTION Function

Deletes a function.

Syntax

FUNCTION delete_function (
  function_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_delete_function_response_t;

Parameters

Parameter	Description
`function_id`	(required) The OCID of this function.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_APPLICATION Function

Retrieves an application.

Syntax

FUNCTION get_application (
  application_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_get_application_response_t;

Parameters

Parameter	Description
`application_id`	(required) The OCID of this application.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_FUNCTION Function

Retrieves a function.

Syntax

FUNCTION get_function (
  function_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_get_function_response_t;

Parameters

Parameter	Description
`function_id`	(required) The OCID of this function.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PBF_LISTING Function

Fetches a Pre-built Function(PBF) Listing. Returns a PbfListing response model.

Syntax

FUNCTION get_pbf_listing (
  pbf_listing_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_get_pbf_listing_response_t;

Parameters

Parameter	Description
`pbf_listing_id`	(required) unique PbfListing identifier
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PBF_LISTING_VERSION Function

Gets a PbfListingVersion by identifier for a PbfListing.

Syntax

FUNCTION get_pbf_listing_version (
  pbf_listing_version_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_get_pbf_listing_version_response_t;

Parameters

Parameter	Description
`pbf_listing_version_id`	(required) unique PbfListingVersion identifier
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_APPLICATIONS Function

Lists applications for a compartment.

Syntax

FUNCTION list_applications (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_list_applications_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment to which this resource belongs.
`limit`	(optional) The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10
`page`	(optional) The pagination token for a list query returned by a previous operation
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`lifecycle_state`	(optional) A filter to return only applications that match the lifecycle state in this parameter. Example: `Creating`
`display_name`	(optional) A filter to return only applications with display names that match the display name string. Matching is exact.
`id`	(optional) A filter to return only applications with the specified OCID.
`sort_order`	(optional) Specifies sort order. * ASC: Ascending sort order. * DESC: Descending sort order. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the attribute with which to sort the rules. Default: `displayName` * timeCreated: Sorts by timeCreated. * displayName: Sorts by displayName. * id: Sorts by id. Allowed values are: 'timeCreated', 'id', 'displayName'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_FUNCTIONS Function

Lists functions for an application.

Syntax

FUNCTION list_functions (
  application_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_list_functions_response_t;

Parameters

Parameter	Description
`application_id`	(required) The OCID of the application to which this function belongs.
`limit`	(optional) The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10
`page`	(optional) The pagination token for a list query returned by a previous operation
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`lifecycle_state`	(optional) A filter to return only functions that match the lifecycle state in this parameter. Example: `Creating`
`display_name`	(optional) A filter to return only functions with display names that match the display name string. Matching is exact.
`id`	(optional) A filter to return only functions with the specified OCID.
`sort_order`	(optional) Specifies sort order. * ASC: Ascending sort order. * DESC: Descending sort order. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) Specifies the attribute with which to sort the rules. Default: `displayName` * timeCreated: Sorts by timeCreated. * displayName: Sorts by displayName. * id: Sorts by id. Allowed values are: 'timeCreated', 'id', 'displayName'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PBF_LISTING_VERSIONS Function

Fetches a wrapped list of all Pre-built Function(PBF) Listing versions. Returns a PbfListingVersionCollection containing an array of PbfListingVersionSummary response models. Note that the PbfListingIdentifier must be provided as a query parameter, otherwise an exception shall be thrown.

Syntax

FUNCTION list_pbf_listing_versions (
  pbf_listing_id varchar2,
  pbf_listing_version_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  is_current_version number DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_list_pbf_listing_versions_response_t;

Parameters

Parameter	Description
`pbf_listing_id`	(required) unique PbfListing identifier
`pbf_listing_version_id`	(optional) unique PbfListingVersion identifier
`name`	(optional) Matches a PbfListingVersion based on a provided semantic version name for a PbfListingVersion. Each PbfListingVersion name is unique with respect to its associated PbfListing.
`is_current_version`	(optional) Matches the current version (the most recently added version with an Active lifecycleState) associated with a PbfListing.
`lifecycle_state`	(optional) A filter to return only resources their lifecycleState matches the given lifecycleState.
`limit`	(optional) The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10
`page`	(optional) The pagination token for a list query returned by a previous operation
`sort_order`	(optional) Specifies sort order. * ASC: Ascending sort order. * DESC: Descending sort order. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. Allowed values are: 'timeCreated', 'name'
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PBF_LISTINGS Function

Fetches a wrapped list of all Pre-built Function(PBF) Listings. Returns a PbfListingCollection containing an array of PbfListingSummary response models.

Syntax

FUNCTION list_pbf_listings (
  pbf_listing_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  name_starts_with varchar2 DEFAULT NULL,
  trigger dbms_cloud_oci_functions_varchar2_tbl DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_list_pbf_listings_response_t;

Parameters

Parameter	Description
`pbf_listing_id`	(optional) unique PbfListing identifier
`name`	(optional) A filter to return only resources that match the entire PBF name given.
`name_contains`	(optional) A filter to return only resources that contain the supplied filter text in the PBF name given.
`name_starts_with`	(optional) A filter to return only resources that start with the supplied filter text in the PBF name given.
`trigger`	(optional) A filter to return only resources that match the service trigger sources of a PBF.
`lifecycle_state`	(optional) A filter to return only resources their lifecycleState matches the given lifecycleState.
`limit`	(optional) The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10
`page`	(optional) The pagination token for a list query returned by a previous operation
`sort_order`	(optional) Specifies sort order. * ASC: Ascending sort order. * DESC: Descending sort order. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. Allowed values are: 'timeCreated', 'name'
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TRIGGERS Function

Returns a list of Triggers.

Syntax

FUNCTION list_triggers (
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_list_triggers_response_t;

Parameters

Parameter	Description
`name`	(optional) A filter to return only resources that match the service trigger source of a PBF.
`limit`	(optional) The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10
`page`	(optional) The pagination token for a list query returned by a previous operation
`sort_order`	(optional) Specifies sort order. * ASC: Ascending sort order. * DESC: Descending sort order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_APPLICATION Function

Modifies an application

Syntax

FUNCTION update_application (
  application_id varchar2,
  update_application_details dbms_cloud_oci_functions_update_application_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_update_application_response_t;

Parameters

Parameter	Description
`application_id`	(required) The OCID of this application.
`update_application_details`	(required) The new application spec to apply
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_FUNCTION Function

Modifies a function

Syntax

FUNCTION update_function (
  function_id varchar2,
  update_function_details dbms_cloud_oci_functions_update_function_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_fnc_functions_management_update_function_response_t;

Parameters

Parameter	Description
`function_id`	(required) The OCID of this function.
`update_function_details`	(required) The new function spec to apply
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://functions.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation

CHANGE_APPLICATION_COMPARTMENT Function

CREATE_APPLICATION Function

CREATE_FUNCTION Function

DELETE_APPLICATION Function

DELETE_FUNCTION Function

GET_APPLICATION Function

GET_FUNCTION Function

GET_PBF_LISTING Function

GET_PBF_LISTING_VERSION Function

LIST_APPLICATIONS Function

LIST_FUNCTIONS Function

LIST_PBF_LISTING_VERSIONS Function

LIST_PBF_LISTINGS Function

LIST_TRIGGERS Function

UPDATE_APPLICATION Function

UPDATE_FUNCTION Function