1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataCatalog
  5. getDataAssets
Oracle Cloud Infrastructure v2.19.0 published on Thursday, Dec 12, 2024 by Pulumi

oci.DataCatalog.getDataAssets

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.19.0 published on Thursday, Dec 12, 2024 by Pulumi

    This data source provides the list of Data Assets in Oracle Cloud Infrastructure Data Catalog service.

    Returns a list of data assets within a data catalog.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.DataCatalog.DataCatalogFunctions;
    import com.pulumi.oci.DataCatalog.inputs.GetDataAssetsArgs;
    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 testDataAssets = DataCatalogFunctions.getDataAssets(GetDataAssetsArgs.builder()
                .catalogId(testCatalog.id())
                .createdById(testCreatedBy.id())
                .displayName(dataAssetDisplayName)
                .displayNameContains(dataAssetDisplayNameContains)
                .externalKey(dataAssetExternalKey)
                .fields(dataAssetFields)
                .state(dataAssetState)
                .timeCreated(dataAssetTimeCreated)
                .timeUpdated(dataAssetTimeUpdated)
                .typeKey(dataAssetTypeKey)
                .updatedById(testUpdatedBy.id())
                .build());
    
        }
    }
    
    variables:
      testDataAssets:
        fn::invoke:
          function: oci:DataCatalog:getDataAssets
          arguments:
            catalogId: ${testCatalog.id}
            createdById: ${testCreatedBy.id}
            displayName: ${dataAssetDisplayName}
            displayNameContains: ${dataAssetDisplayNameContains}
            externalKey: ${dataAssetExternalKey}
            fields: ${dataAssetFields}
            state: ${dataAssetState}
            timeCreated: ${dataAssetTimeCreated}
            timeUpdated: ${dataAssetTimeUpdated}
            typeKey: ${dataAssetTypeKey}
            updatedById: ${testUpdatedBy.id}
    

    Using getDataAssets

    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 getDataAssets(args: GetDataAssetsArgs, opts?: InvokeOptions): Promise<GetDataAssetsResult>
    function getDataAssetsOutput(args: GetDataAssetsOutputArgs, opts?: InvokeOptions): Output<GetDataAssetsResult>
    def get_data_assets(catalog_id: Optional[str] = None,
                        created_by_id: Optional[str] = None,
                        display_name: Optional[str] = None,
                        display_name_contains: Optional[str] = None,
                        external_key: Optional[str] = None,
                        fields: Optional[Sequence[str]] = None,
                        filters: Optional[Sequence[_datacatalog.GetDataAssetsFilter]] = None,
                        state: Optional[str] = None,
                        type_key: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetDataAssetsResult
    def get_data_assets_output(catalog_id: Optional[pulumi.Input[str]] = None,
                        created_by_id: Optional[pulumi.Input[str]] = None,
                        display_name: Optional[pulumi.Input[str]] = None,
                        display_name_contains: Optional[pulumi.Input[str]] = None,
                        external_key: Optional[pulumi.Input[str]] = None,
                        fields: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datacatalog.GetDataAssetsFilterArgs]]]] = None,
                        state: Optional[pulumi.Input[str]] = None,
                        type_key: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetDataAssetsResult]
    func GetDataAssets(ctx *Context, args *GetDataAssetsArgs, opts ...InvokeOption) (*GetDataAssetsResult, error)
    func GetDataAssetsOutput(ctx *Context, args *GetDataAssetsOutputArgs, opts ...InvokeOption) GetDataAssetsResultOutput

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

    public static class GetDataAssets 
    {
        public static Task<GetDataAssetsResult> InvokeAsync(GetDataAssetsArgs args, InvokeOptions? opts = null)
        public static Output<GetDataAssetsResult> Invoke(GetDataAssetsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDataAssetsResult> getDataAssets(GetDataAssetsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:DataCatalog/getDataAssets:getDataAssets
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CatalogId string
    Unique catalog identifier.
    CreatedById string
    OCID of the user who created the resource.
    DisplayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    DisplayNameContains string
    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
    ExternalKey string
    Unique external identifier of this resource in the external source system.
    Fields List<string>
    Specifies the fields to return in a data asset summary response.
    Filters List<GetDataAssetsFilter>
    State string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    TypeKey string
    The key of the object type.
    CatalogId string
    Unique catalog identifier.
    CreatedById string
    OCID of the user who created the resource.
    DisplayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    DisplayNameContains string
    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
    ExternalKey string
    Unique external identifier of this resource in the external source system.
    Fields []string
    Specifies the fields to return in a data asset summary response.
    Filters []GetDataAssetsFilter
    State string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    TypeKey string
    The key of the object type.
    catalogId String
    Unique catalog identifier.
    createdById String
    OCID of the user who created the resource.
    displayName String
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    displayNameContains String
    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
    externalKey String
    Unique external identifier of this resource in the external source system.
    fields List<String>
    Specifies the fields to return in a data asset summary response.
    filters List<GetDataAssetsFilter>
    state String
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    typeKey String
    The key of the object type.
    catalogId string
    Unique catalog identifier.
    createdById string
    OCID of the user who created the resource.
    displayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    displayNameContains string
    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
    externalKey string
    Unique external identifier of this resource in the external source system.
    fields string[]
    Specifies the fields to return in a data asset summary response.
    filters GetDataAssetsFilter[]
    state string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    typeKey string
    The key of the object type.
    catalog_id str
    Unique catalog identifier.
    created_by_id str
    OCID of the user who created the resource.
    display_name str
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    display_name_contains str
    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
    external_key str
    Unique external identifier of this resource in the external source system.
    fields Sequence[str]
    Specifies the fields to return in a data asset summary response.
    filters Sequence[datacatalog.GetDataAssetsFilter]
    state str
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    type_key str
    The key of the object type.
    catalogId String
    Unique catalog identifier.
    createdById String
    OCID of the user who created the resource.
    displayName String
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    displayNameContains String
    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
    externalKey String
    Unique external identifier of this resource in the external source system.
    fields List<String>
    Specifies the fields to return in a data asset summary response.
    filters List<Property Map>
    state String
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    typeKey String
    The key of the object type.

    getDataAssets Result

    The following output properties are available:

    CatalogId string
    The data catalog's OCID.
    DataAssetCollections List<GetDataAssetsDataAssetCollection>
    The list of data_asset_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedById string
    OCID of the user who created the data asset.
    DisplayName string
    A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    DisplayNameContains string
    ExternalKey string
    External URI that can be used to reference the object. Format will differ based on the type of object.
    Fields List<string>
    Filters List<GetDataAssetsFilter>
    State string
    The current state of the data asset.
    TypeKey string
    The key of the object type. Type key's can be found via the '/types' endpoint.
    CatalogId string
    The data catalog's OCID.
    DataAssetCollections []GetDataAssetsDataAssetCollection
    The list of data_asset_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedById string
    OCID of the user who created the data asset.
    DisplayName string
    A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    DisplayNameContains string
    ExternalKey string
    External URI that can be used to reference the object. Format will differ based on the type of object.
    Fields []string
    Filters []GetDataAssetsFilter
    State string
    The current state of the data asset.
    TypeKey string
    The key of the object type. Type key's can be found via the '/types' endpoint.
    catalogId String
    The data catalog's OCID.
    dataAssetCollections List<GetDataAssetsDataAssetCollection>
    The list of data_asset_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    createdById String
    OCID of the user who created the data asset.
    displayName String
    A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    displayNameContains String
    externalKey String
    External URI that can be used to reference the object. Format will differ based on the type of object.
    fields List<String>
    filters List<GetDataAssetsFilter>
    state String
    The current state of the data asset.
    typeKey String
    The key of the object type. Type key's can be found via the '/types' endpoint.
    catalogId string
    The data catalog's OCID.
    dataAssetCollections GetDataAssetsDataAssetCollection[]
    The list of data_asset_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    createdById string
    OCID of the user who created the data asset.
    displayName string
    A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    displayNameContains string
    externalKey string
    External URI that can be used to reference the object. Format will differ based on the type of object.
    fields string[]
    filters GetDataAssetsFilter[]
    state string
    The current state of the data asset.
    typeKey string
    The key of the object type. Type key's can be found via the '/types' endpoint.
    catalog_id str
    The data catalog's OCID.
    data_asset_collections Sequence[datacatalog.GetDataAssetsDataAssetCollection]
    The list of data_asset_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    created_by_id str
    OCID of the user who created the data asset.
    display_name str
    A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    display_name_contains str
    external_key str
    External URI that can be used to reference the object. Format will differ based on the type of object.
    fields Sequence[str]
    filters Sequence[datacatalog.GetDataAssetsFilter]
    state str
    The current state of the data asset.
    type_key str
    The key of the object type. Type key's can be found via the '/types' endpoint.
    catalogId String
    The data catalog's OCID.
    dataAssetCollections List<Property Map>
    The list of data_asset_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    createdById String
    OCID of the user who created the data asset.
    displayName String
    A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    displayNameContains String
    externalKey String
    External URI that can be used to reference the object. Format will differ based on the type of object.
    fields List<String>
    filters List<Property Map>
    state String
    The current state of the data asset.
    typeKey String
    The key of the object type. Type key's can be found via the '/types' endpoint.

    Supporting Types

    GetDataAssetsDataAssetCollection

    GetDataAssetsDataAssetCollectionItem

    CatalogId string
    Unique catalog identifier.
    CreatedById string
    OCID of the user who created the resource.
    Description string
    Detailed description of the data asset.
    DisplayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    ExternalKey string
    Unique external identifier of this resource in the external source system.
    Key string
    Unique data asset key that is immutable.
    LifecycleDetails string
    A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.
    Properties Dictionary<string, string>
    A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
    State string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    TimeCreated string
    Time that the resource was created. An RFC3339 formatted datetime string.
    TimeHarvested string
    The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
    TimeUpdated string
    Time that the resource was updated. An RFC3339 formatted datetime string.
    TypeKey string
    The key of the object type.
    UpdatedById string
    OCID of the user who updated the resource.
    Uri string
    URI to the data asset instance in the API.
    CatalogId string
    Unique catalog identifier.
    CreatedById string
    OCID of the user who created the resource.
    Description string
    Detailed description of the data asset.
    DisplayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    ExternalKey string
    Unique external identifier of this resource in the external source system.
    Key string
    Unique data asset key that is immutable.
    LifecycleDetails string
    A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.
    Properties map[string]string
    A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
    State string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    TimeCreated string
    Time that the resource was created. An RFC3339 formatted datetime string.
    TimeHarvested string
    The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
    TimeUpdated string
    Time that the resource was updated. An RFC3339 formatted datetime string.
    TypeKey string
    The key of the object type.
    UpdatedById string
    OCID of the user who updated the resource.
    Uri string
    URI to the data asset instance in the API.
    catalogId String
    Unique catalog identifier.
    createdById String
    OCID of the user who created the resource.
    description String
    Detailed description of the data asset.
    displayName String
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    externalKey String
    Unique external identifier of this resource in the external source system.
    key String
    Unique data asset key that is immutable.
    lifecycleDetails String
    A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.
    properties Map<String,String>
    A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
    state String
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    timeCreated String
    Time that the resource was created. An RFC3339 formatted datetime string.
    timeHarvested String
    The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
    timeUpdated String
    Time that the resource was updated. An RFC3339 formatted datetime string.
    typeKey String
    The key of the object type.
    updatedById String
    OCID of the user who updated the resource.
    uri String
    URI to the data asset instance in the API.
    catalogId string
    Unique catalog identifier.
    createdById string
    OCID of the user who created the resource.
    description string
    Detailed description of the data asset.
    displayName string
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    externalKey string
    Unique external identifier of this resource in the external source system.
    key string
    Unique data asset key that is immutable.
    lifecycleDetails string
    A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.
    properties {[key: string]: string}
    A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
    state string
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    timeCreated string
    Time that the resource was created. An RFC3339 formatted datetime string.
    timeHarvested string
    The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
    timeUpdated string
    Time that the resource was updated. An RFC3339 formatted datetime string.
    typeKey string
    The key of the object type.
    updatedById string
    OCID of the user who updated the resource.
    uri string
    URI to the data asset instance in the API.
    catalog_id str
    Unique catalog identifier.
    created_by_id str
    OCID of the user who created the resource.
    description str
    Detailed description of the data asset.
    display_name str
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    external_key str
    Unique external identifier of this resource in the external source system.
    key str
    Unique data asset key that is immutable.
    lifecycle_details str
    A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.
    properties Mapping[str, str]
    A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
    state str
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    time_created str
    Time that the resource was created. An RFC3339 formatted datetime string.
    time_harvested str
    The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
    time_updated str
    Time that the resource was updated. An RFC3339 formatted datetime string.
    type_key str
    The key of the object type.
    updated_by_id str
    OCID of the user who updated the resource.
    uri str
    URI to the data asset instance in the API.
    catalogId String
    Unique catalog identifier.
    createdById String
    OCID of the user who created the resource.
    description String
    Detailed description of the data asset.
    displayName String
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    externalKey String
    Unique external identifier of this resource in the external source system.
    key String
    Unique data asset key that is immutable.
    lifecycleDetails String
    A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.
    properties Map<String>
    A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}
    state String
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    timeCreated String
    Time that the resource was created. An RFC3339 formatted datetime string.
    timeHarvested String
    The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
    timeUpdated String
    Time that the resource was updated. An RFC3339 formatted datetime string.
    typeKey String
    The key of the object type.
    updatedById String
    OCID of the user who updated the resource.
    uri String
    URI to the data asset instance in the API.

    GetDataAssetsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    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 v2.19.0 published on Thursday, Dec 12, 2024 by Pulumi