1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Functions
  5. getPbfListings
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

oci.Functions.getPbfListings

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

    This data source provides the list of Pbf Listings in Oracle Cloud Infrastructure Functions service.

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

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testPbfListings = Oci.Functions.GetPbfListings.Invoke(new()
        {
            Name = @var.Pbf_listing_name,
            NameContains = @var.Pbf_listing_name_contains,
            NameStartsWith = @var.Pbf_listing_name_starts_with,
            PbfListingId = oci_functions_pbf_listing.Test_pbf_listing.Id,
            State = @var.Pbf_listing_state,
            Triggers = @var.Pbf_listing_trigger,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Functions"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Functions.GetPbfListings(ctx, &functions.GetPbfListingsArgs{
    			Name:           pulumi.StringRef(_var.Pbf_listing_name),
    			NameContains:   pulumi.StringRef(_var.Pbf_listing_name_contains),
    			NameStartsWith: pulumi.StringRef(_var.Pbf_listing_name_starts_with),
    			PbfListingId:   pulumi.StringRef(oci_functions_pbf_listing.Test_pbf_listing.Id),
    			State:          pulumi.StringRef(_var.Pbf_listing_state),
    			Triggers:       _var.Pbf_listing_trigger,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Functions.FunctionsFunctions;
    import com.pulumi.oci.Functions.inputs.GetPbfListingsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testPbfListings = FunctionsFunctions.getPbfListings(GetPbfListingsArgs.builder()
                .name(var_.pbf_listing_name())
                .nameContains(var_.pbf_listing_name_contains())
                .nameStartsWith(var_.pbf_listing_name_starts_with())
                .pbfListingId(oci_functions_pbf_listing.test_pbf_listing().id())
                .state(var_.pbf_listing_state())
                .triggers(var_.pbf_listing_trigger())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_pbf_listings = oci.Functions.get_pbf_listings(name=var["pbf_listing_name"],
        name_contains=var["pbf_listing_name_contains"],
        name_starts_with=var["pbf_listing_name_starts_with"],
        pbf_listing_id=oci_functions_pbf_listing["test_pbf_listing"]["id"],
        state=var["pbf_listing_state"],
        triggers=var["pbf_listing_trigger"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testPbfListings = oci.Functions.getPbfListings({
        name: _var.pbf_listing_name,
        nameContains: _var.pbf_listing_name_contains,
        nameStartsWith: _var.pbf_listing_name_starts_with,
        pbfListingId: oci_functions_pbf_listing.test_pbf_listing.id,
        state: _var.pbf_listing_state,
        triggers: _var.pbf_listing_trigger,
    });
    
    variables:
      testPbfListings:
        fn::invoke:
          Function: oci:Functions:getPbfListings
          Arguments:
            name: ${var.pbf_listing_name}
            nameContains: ${var.pbf_listing_name_contains}
            nameStartsWith: ${var.pbf_listing_name_starts_with}
            pbfListingId: ${oci_functions_pbf_listing.test_pbf_listing.id}
            state: ${var.pbf_listing_state}
            triggers: ${var.pbf_listing_trigger}
    

    Using getPbfListings

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPbfListings(args: GetPbfListingsArgs, opts?: InvokeOptions): Promise<GetPbfListingsResult>
    function getPbfListingsOutput(args: GetPbfListingsOutputArgs, opts?: InvokeOptions): Output<GetPbfListingsResult>
    def get_pbf_listings(filters: Optional[Sequence[_functions.GetPbfListingsFilter]] = None,
                         name: Optional[str] = None,
                         name_contains: Optional[str] = None,
                         name_starts_with: Optional[str] = None,
                         pbf_listing_id: Optional[str] = None,
                         state: Optional[str] = None,
                         triggers: Optional[Sequence[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPbfListingsResult
    def get_pbf_listings_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[_functions.GetPbfListingsFilterArgs]]]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         name_contains: Optional[pulumi.Input[str]] = None,
                         name_starts_with: Optional[pulumi.Input[str]] = None,
                         pbf_listing_id: Optional[pulumi.Input[str]] = None,
                         state: Optional[pulumi.Input[str]] = None,
                         triggers: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPbfListingsResult]
    func GetPbfListings(ctx *Context, args *GetPbfListingsArgs, opts ...InvokeOption) (*GetPbfListingsResult, error)
    func GetPbfListingsOutput(ctx *Context, args *GetPbfListingsOutputArgs, opts ...InvokeOption) GetPbfListingsResultOutput

    > Note: This function is named GetPbfListings in the Go SDK.

    public static class GetPbfListings 
    {
        public static Task<GetPbfListingsResult> InvokeAsync(GetPbfListingsArgs args, InvokeOptions? opts = null)
        public static Output<GetPbfListingsResult> Invoke(GetPbfListingsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPbfListingsResult> getPbfListings(GetPbfListingsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Functions/getPbfListings:getPbfListings
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filters List<GetPbfListingsFilter>
    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.
    PbfListingId string
    unique PbfListing identifier
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    Triggers List<string>
    A filter to return only resources that match the service trigger sources of a PBF.
    Filters []GetPbfListingsFilter
    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.
    PbfListingId string
    unique PbfListing identifier
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    Triggers []string
    A filter to return only resources that match the service trigger sources of a PBF.
    filters List<GetPbfListingsFilter>
    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.
    pbfListingId String
    unique PbfListing identifier
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    triggers List<String>
    A filter to return only resources that match the service trigger sources of a PBF.
    filters GetPbfListingsFilter[]
    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.
    pbfListingId string
    unique PbfListing identifier
    state string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    triggers string[]
    A filter to return only resources that match the service trigger sources of a PBF.
    filters GetPbfListingsFilter]
    name str
    A filter to return only resources that match the entire PBF name given.
    name_contains str
    A filter to return only resources that contain the supplied filter text in the PBF name given.
    name_starts_with str
    A filter to return only resources that start with the supplied filter text in the PBF name given.
    pbf_listing_id str
    unique PbfListing identifier
    state str
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    triggers Sequence[str]
    A filter to return only resources that match the service trigger sources of a PBF.
    filters List<Property Map>
    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.
    pbfListingId String
    unique PbfListing identifier
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    triggers List<String>
    A filter to return only resources that match the service trigger sources of a PBF.

    getPbfListings Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    PbfListingsCollections List<GetPbfListingsPbfListingsCollection>
    The list of pbf_listings_collection.
    Filters List<GetPbfListingsFilter>
    Name string
    A brief descriptive name for the PBF trigger.
    NameContains string
    NameStartsWith string
    PbfListingId string
    State string
    The current state of the PBF resource.
    Triggers List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    PbfListingsCollections []GetPbfListingsPbfListingsCollection
    The list of pbf_listings_collection.
    Filters []GetPbfListingsFilter
    Name string
    A brief descriptive name for the PBF trigger.
    NameContains string
    NameStartsWith string
    PbfListingId string
    State string
    The current state of the PBF resource.
    Triggers []string
    id String
    The provider-assigned unique ID for this managed resource.
    pbfListingsCollections List<GetPbfListingsPbfListingsCollection>
    The list of pbf_listings_collection.
    filters List<GetPbfListingsFilter>
    name String
    A brief descriptive name for the PBF trigger.
    nameContains String
    nameStartsWith String
    pbfListingId String
    state String
    The current state of the PBF resource.
    triggers List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    pbfListingsCollections GetPbfListingsPbfListingsCollection[]
    The list of pbf_listings_collection.
    filters GetPbfListingsFilter[]
    name string
    A brief descriptive name for the PBF trigger.
    nameContains string
    nameStartsWith string
    pbfListingId string
    state string
    The current state of the PBF resource.
    triggers string[]
    id str
    The provider-assigned unique ID for this managed resource.
    pbf_listings_collections GetPbfListingsPbfListingsCollection]
    The list of pbf_listings_collection.
    filters GetPbfListingsFilter]
    name str
    A brief descriptive name for the PBF trigger.
    name_contains str
    name_starts_with str
    pbf_listing_id str
    state str
    The current state of the PBF resource.
    triggers Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    pbfListingsCollections List<Property Map>
    The list of pbf_listings_collection.
    filters List<Property Map>
    name String
    A brief descriptive name for the PBF trigger.
    nameContains String
    nameStartsWith String
    pbfListingId String
    state String
    The current state of the PBF resource.
    triggers List<String>

    Supporting Types

    GetPbfListingsFilter

    Name string
    A filter to return only resources that match the entire PBF name given.
    Values List<string>
    Regex bool
    Name string
    A filter to return only resources that match the entire PBF name given.
    Values []string
    Regex bool
    name String
    A filter to return only resources that match the entire PBF name given.
    values List<String>
    regex Boolean
    name string
    A filter to return only resources that match the entire PBF name given.
    values string[]
    regex boolean
    name str
    A filter to return only resources that match the entire PBF name given.
    values Sequence[str]
    regex bool
    name String
    A filter to return only resources that match the entire PBF name given.
    values List<String>
    regex Boolean

    GetPbfListingsPbfListingsCollection

    items List<Property Map>
    List of PbfListingSummary.

    GetPbfListingsPbfListingsCollectionItem

    DefinedTags Dictionary<string, 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.
    FreeformTags Dictionary<string, object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    Unique identifier that is immutable on creation.
    Name string
    A filter to return only resources that match the entire PBF name given.
    PublisherDetails List<GetPbfListingsPbfListingsCollectionItemPublisherDetail>
    Contains details about the publisher of this PBF Listing.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the PbfListing was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The last time the PbfListing was updated. An RFC3339 formatted datetime string.
    Triggers List<GetPbfListingsPbfListingsCollectionItemTrigger>
    An array of Trigger. A list of triggers that may activate the PBF.
    DefinedTags map[string]interface{}
    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.
    FreeformTags map[string]interface{}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    Unique identifier that is immutable on creation.
    Name string
    A filter to return only resources that match the entire PBF name given.
    PublisherDetails []GetPbfListingsPbfListingsCollectionItemPublisherDetail
    Contains details about the publisher of this PBF Listing.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the PbfListing was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The last time the PbfListing was updated. An RFC3339 formatted datetime string.
    Triggers []GetPbfListingsPbfListingsCollectionItemTrigger
    An array of Trigger. A list of triggers that may activate the PBF.
    definedTags Map<String,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.
    freeformTags Map<String,Object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    Unique identifier that is immutable on creation.
    name String
    A filter to return only resources that match the entire PBF name given.
    publisherDetails List<GetPbfListingsPbfListingsCollectionItemPublisherDetail>
    Contains details about the publisher of this PBF Listing.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the PbfListing was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The last time the PbfListing was updated. An RFC3339 formatted datetime string.
    triggers List<GetPbfListingsPbfListingsCollectionItemTrigger>
    An array of Trigger. A list of triggers that may activate the PBF.
    definedTags {[key: string]: any}
    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.
    freeformTags {[key: string]: any}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    Unique identifier that is immutable on creation.
    name string
    A filter to return only resources that match the entire PBF name given.
    publisherDetails GetPbfListingsPbfListingsCollectionItemPublisherDetail[]
    Contains details about the publisher of this PBF Listing.
    state string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the PbfListing was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The last time the PbfListing was updated. An RFC3339 formatted datetime string.
    triggers GetPbfListingsPbfListingsCollectionItemTrigger[]
    An array of Trigger. A list of triggers that may activate the PBF.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    A short overview of the PBF Listing: the purpose of the PBF and and associated information.
    freeform_tags Mapping[str, Any]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    Unique identifier that is immutable on creation.
    name str
    A filter to return only resources that match the entire PBF name given.
    publisher_details GetPbfListingsPbfListingsCollectionItemPublisherDetail]
    Contains details about the publisher of this PBF Listing.
    state str
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the PbfListing was created. An RFC3339 formatted datetime string.
    time_updated str
    The last time the PbfListing was updated. An RFC3339 formatted datetime string.
    triggers GetPbfListingsPbfListingsCollectionItemTrigger]
    An array of Trigger. A list of triggers that may activate the PBF.
    definedTags Map<Any>
    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.
    freeformTags Map<Any>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    Unique identifier that is immutable on creation.
    name String
    A filter to return only resources that match the entire PBF name given.
    publisherDetails List<Property Map>
    Contains details about the publisher of this PBF Listing.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the PbfListing was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The last time the PbfListing was updated. An RFC3339 formatted datetime string.
    triggers List<Property Map>
    An array of Trigger. A list of triggers that may activate the PBF.

    GetPbfListingsPbfListingsCollectionItemPublisherDetail

    Name string
    A filter to return only resources that match the entire PBF name given.
    Name string
    A filter to return only resources that match the entire PBF name given.
    name String
    A filter to return only resources that match the entire PBF name given.
    name string
    A filter to return only resources that match the entire PBF name given.
    name str
    A filter to return only resources that match the entire PBF name given.
    name String
    A filter to return only resources that match the entire PBF name given.

    GetPbfListingsPbfListingsCollectionItemTrigger

    Name string
    A filter to return only resources that match the entire PBF name given.
    Name string
    A filter to return only resources that match the entire PBF name given.
    name String
    A filter to return only resources that match the entire PBF name given.
    name string
    A filter to return only resources that match the entire PBF name given.
    name str
    A filter to return only resources that match the entire PBF name given.
    name String
    A filter to return only resources that match the entire PBF name given.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi