pbf_listing_versions

Creates, updates, deletes, gets or lists a pbf_listing_versions resource.

Overview

Name	pbf_listing_versions
Type	Resource
Id	oci.functions.pbf_listing_versions

Fields

The following fields are returned by SELECT queries:

get

Retrieves the PbfListingVersion for the given PbfListing id and version.

Name	Datatype	Description
id	string	Unique identifier that is immutable on creation (example: ocid1.pbflistingversion.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq)
name	string	Semantic version (example: 0.0.1)
changeSummary	string	Details changes are included in this version. (example: First release of the PBF.<br />)
config	array	Details about the required and optional Function configurations needed for proper performance of the PBF. (x-default-description: null)
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: &#123;"foo-namespace": &#123;"bar-key": "value"&#125;&#125;
freeformTags	object	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: &#123;"bar-key": "value"&#125;
lifecycleState	string	The current state of the PBF resource. (ACTIVE, INACTIVE, DELETED)
pbfListingId	string	The OCID of the PbfListing this resource version belongs to. (example: ocid1.pbflisting.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq)
requirements	object	Minimum memory required by this PBF. The user should use memory greater than or equal to this value while configuring the Function.
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. Example: &#123;"orcl-cloud": &#123;"free-tier-retained": "true"&#125;&#125;
timeCreated	string (date-time)	The time the PbfListingVersion was created. An RFC3339 formatted datetime string. (example: 2022-09-30T0710:20:50.52Z)
timeUpdated	string (date-time)	The last time the PbfListingVersion was updated. An RFC3339 formatted datetime string. (example: 2022-09-30T0710:20:50.52Z)
triggers	array	An array of Trigger. A list of triggers that may activate the PBF.

list

A page of PbfListingVersionSummary objects.

Name	Datatype	Description
id	string	Unique identifier that is immutable on creation (example: ocid1.pbflistingversion.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq)
name	string	Semantic version (example: 0.0.1)
changeSummary	string	Details changes are included in this version. (example: First release of the PBF.<br />)
config	array	Details about the required and optional Function configurations needed for proper performance of the PBF. (x-default-description: null)
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: &#123;"foo-namespace": &#123;"bar-key": "value"&#125;&#125;
freeformTags	object	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: &#123;"bar-key": "value"&#125;
lifecycleState	string	The current state of the PBF resource. (x-obmcs-enumref: #/definitions/PbfListingVersion/lifecycleState)
pbfListingId	string	The OCID of the PbfListing this resource version belongs to. (example: ocid1.pbflisting.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq)
requirements	object	Minimum memory required by this PBF. The user should use memory greater than or equal to this value while configuring the Function.
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. Example: &#123;"orcl-cloud": &#123;"free-tier-retained": "true"&#125;&#125;
timeCreated	string (date-time)	The time the PbfListingVersion was created. An RFC3339 formatted datetime string. (example: 2022-09-30T0710:20:50.52Z)
timeUpdated	string (date-time)	The last time the PbfListingVersion was updated. An RFC3339 formatted datetime string. (example: 2022-09-30T0710:20:50.52Z)
triggers	array	An array of Trigger. A list of triggers that may activate the PBF.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	pbfListingVersionId, region	opc-request-id	Gets a PbfListingVersion by identifier for a PbfListing.
list	select	pbfListingId, region	pbfListingVersionId, name, isCurrentVersion, lifecycleState, limit, page, sortOrder, sortBy, opc-request-id	Fetches a wrapped list of all Pre-built Function(PBF) Listing versions. Returns a PbfListingVersionCollection <br />containing an array of PbfListingVersionSummary response models.<br /><br />Note that the PbfListingIdentifier must be provided as a query parameter, otherwise an exception shall <br />be thrown.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
pbfListingId	string	unique PbfListing identifier
pbfListingVersionId	string	unique PbfListingVersion identifier
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
isCurrentVersion	boolean	Matches the current version (the most recently added version with an Active lifecycleState) associated with a PbfListing.
lifecycleState	string	A filter to return only resources their lifecycleState matches the given lifecycleState.
limit	integer	The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10
name	string	Matches a PbfListingVersion based on a provided semantic version name for a PbfListingVersion. Each PbfListingVersion name is unique with respect to its associated PbfListing.
opc-request-id	string	The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
page	string	The pagination token for a list query returned by a previous operation
pbfListingVersionId	string	unique PbfListingVersion identifier
sortBy	string	The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending.
sortOrder	string	Specifies sort order. * ASC: Ascending sort order. * DESC: Descending sort order.

SELECT examples

get

Gets a PbfListingVersion by identifier for a PbfListing.

SELECT
id,
name,
changeSummary,
config,
definedTags,
freeformTags,
lifecycleState,
pbfListingId,
requirements,
systemTags,
timeCreated,
timeUpdated,
triggers
FROM oci.functions.pbf_listing_versions
WHERE pbfListingVersionId = '{{ pbfListingVersionId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

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

SELECT
id,
name,
changeSummary,
config,
definedTags,
freeformTags,
lifecycleState,
pbfListingId,
requirements,
systemTags,
timeCreated,
timeUpdated,
triggers
FROM oci.functions.pbf_listing_versions
WHERE pbfListingId = '{{ pbfListingId }}' -- required
AND region = '{{ region }}' -- required
AND pbfListingVersionId = '{{ pbfListingVersionId }}'
AND name = '{{ name }}'
AND isCurrentVersion = '{{ isCurrentVersion }}'
AND lifecycleState = '{{ lifecycleState }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortOrder = '{{ sortOrder }}'
AND sortBy = '{{ sortBy }}'
AND opc-request-id = '{{ opc-request-id }}'
;