pbf_listings

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

Overview

Name	pbf_listings
Type	Resource
Id	oci.functions.pbf_listings

Fields

The following fields are returned by SELECT queries:

get

Retrieves the PbfListing with the given id.

Name	Datatype	Description
id	string	Unique identifier that is immutable on creation. (example: ocid1.pbflisting.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq)
name	string	A brief descriptive name for the PBF listing. The PBF listing name must be unique, and not match and existing PBF. (example: Logs to Splunk)
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
description	string	A short overview of the PBF Listing: the purpose of the PBF and and associated information. (example: A PBF to transform and send logs, metrics and data to Splunk. The PBF pushes data to Splunk through <br />http/post requests and Splunk's HEC module (https:​//docs.splunk.com/Documentation/Splunk/9.0.0/Data/UsetheHTTPEventCollector).<br />)
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)
publisherDetails	object	Contains details about the publisher of this PBF Listing.
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 PbfListing was created. An RFC3339 formatted datetime string. (example: 2022-09-30T0710:20:50.52Z)
timeUpdated	string (date-time)	The last time the PbfListing 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 PbfListingSummary objects.

Name	Datatype	Description
id	string	Unique identifier that is immutable on creation. (example: ocid1.pbflisting.oc1.iad.aaaaaaaal3dkjeliven6l7kw3kiwlkbqjtfhdra6fly7uqekgmuef6forplq)
name	string	A brief descriptive name for the PBF listing. The PBF listing name must be unique, and not match and existing PBF. (example: Logs to Splunk)
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
description	string	A short overview of the PBF Listing: the purpose of the PBF and and associated information. (example: A PBF to transform and send logs, metrics and data to Splunk. The PBF pushes data to Splunk through <br />http/post requests and Splunk's HEC module (https:​//docs.splunk.com/Documentation/Splunk/9.0.0/Data/UsetheHTTPEventCollector).<br />)
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/PbfListing/lifecycleState)
publisherDetails	object	Contains details about the publisher of this PBF Listing.
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 PbfListing was created. An RFC3339 formatted datetime string. (example: 2022-09-30T0710:20:50.52Z)
timeUpdated	string (date-time)	The last time the PbfListing 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	pbfListingId, region	opc-request-id	Fetches a Pre-built Function(PBF) Listing. Returns a PbfListing response model.<br />
list	select	region	pbfListingId, name, nameContains, nameStartsWith, trigger, lifecycleState, limit, page, sortOrder, sortBy, opc-request-id	Fetches a wrapped list of all Pre-built Function(PBF) Listings. Returns a PbfListingCollection containing <br />an array of PbfListingSummary response models.<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
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)
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	A filter to return only resources that match the entire PBF name given.
nameContains	string	A filter to return only resources that contain the supplied filter text in the PBF name given.
nameStartsWith	string	A filter to return only resources that start with the supplied filter text in the PBF name given.
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
pbfListingId	string	unique PbfListing 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.
trigger	array	A filter to return only resources that match the service trigger sources of a PBF.

SELECT examples

get

Fetches a Pre-built Function(PBF) Listing. Returns a PbfListing response model.<br />

SELECT
id,
name,
definedTags,
description,
freeformTags,
lifecycleState,
publisherDetails,
systemTags,
timeCreated,
timeUpdated,
triggers
FROM oci.functions.pbf_listings
WHERE pbfListingId = '{{ pbfListingId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

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

SELECT
id,
name,
definedTags,
description,
freeformTags,
lifecycleState,
publisherDetails,
systemTags,
timeCreated,
timeUpdated,
triggers
FROM oci.functions.pbf_listings
WHERE region = '{{ region }}' -- required
AND pbfListingId = '{{ pbfListingId }}'
AND name = '{{ name }}'
AND nameContains = '{{ nameContains }}'
AND nameStartsWith = '{{ nameStartsWith }}'
AND trigger = '{{ trigger }}'
AND lifecycleState = '{{ lifecycleState }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortOrder = '{{ sortOrder }}'
AND sortBy = '{{ sortBy }}'
AND opc-request-id = '{{ opc-request-id }}'
;