Oracle Cloud Infrastructure v2.19.0 published on Thursday, Dec 12, 2024 by Pulumi
oci.DataCatalog.getDataAssets
Explore with Pulumi AI
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:
- Catalog
Id string - Unique catalog identifier.
- Created
By stringId - OCID of the user who created the resource.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Display
Name stringContains - 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 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<Get
Data Assets Filter> - State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- Type
Key string - The key of the object type.
- Catalog
Id string - Unique catalog identifier.
- Created
By stringId - OCID of the user who created the resource.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Display
Name stringContains - 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 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
[]Get
Data Assets Filter - State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- Type
Key string - The key of the object type.
- catalog
Id String - Unique catalog identifier.
- created
By StringId - OCID of the user who created the resource.
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- display
Name StringContains - 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 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<Get
Data Assets Filter> - state String
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- type
Key String - The key of the object type.
- catalog
Id string - Unique catalog identifier.
- created
By stringId - OCID of the user who created the resource.
- display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- display
Name stringContains - 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 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
Get
Data Assets Filter[] - state string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- type
Key string - The key of the object type.
- catalog_
id str - Unique catalog identifier.
- created_
by_ strid - 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_ strcontains - 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.
Get Data Assets Filter] - 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.
- catalog
Id String - Unique catalog identifier.
- created
By StringId - OCID of the user who created the resource.
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- display
Name StringContains - 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 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.
- type
Key String - The key of the object type.
getDataAssets Result
The following output properties are available:
- Catalog
Id string - The data catalog's OCID.
- Data
Asset List<GetCollections Data Assets Data Asset Collection> - The list of data_asset_collection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Created
By stringId - OCID of the user who created the data asset.
- Display
Name string - A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Display
Name stringContains - External
Key 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<Get
Data Assets Filter> - State string
- The current state of the data asset.
- Type
Key string - The key of the object type. Type key's can be found via the '/types' endpoint.
- Catalog
Id string - The data catalog's OCID.
- Data
Asset []GetCollections Data Assets Data Asset Collection - The list of data_asset_collection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Created
By stringId - OCID of the user who created the data asset.
- Display
Name string - A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Display
Name stringContains - External
Key string - External URI that can be used to reference the object. Format will differ based on the type of object.
- Fields []string
- Filters
[]Get
Data Assets Filter - State string
- The current state of the data asset.
- Type
Key string - The key of the object type. Type key's can be found via the '/types' endpoint.
- catalog
Id String - The data catalog's OCID.
- data
Asset List<GetCollections Data Assets Data Asset Collection> - The list of data_asset_collection.
- id String
- The provider-assigned unique ID for this managed resource.
- created
By StringId - OCID of the user who created the data asset.
- display
Name String - A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- display
Name StringContains - external
Key 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<Get
Data Assets Filter> - state String
- The current state of the data asset.
- type
Key String - The key of the object type. Type key's can be found via the '/types' endpoint.
- catalog
Id string - The data catalog's OCID.
- data
Asset GetCollections Data Assets Data Asset Collection[] - The list of data_asset_collection.
- id string
- The provider-assigned unique ID for this managed resource.
- created
By stringId - OCID of the user who created the data asset.
- display
Name string - A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- display
Name stringContains - external
Key string - External URI that can be used to reference the object. Format will differ based on the type of object.
- fields string[]
- filters
Get
Data Assets Filter[] - state string
- The current state of the data asset.
- type
Key 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_ Sequence[datacatalog.collections Get Data Assets Data Asset Collection] - The list of data_asset_collection.
- id str
- The provider-assigned unique ID for this managed resource.
- created_
by_ strid - 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_ strcontains - 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.
Get Data Assets Filter] - 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.
- catalog
Id String - The data catalog's OCID.
- data
Asset List<Property Map>Collections - The list of data_asset_collection.
- id String
- The provider-assigned unique ID for this managed resource.
- created
By StringId - OCID of the user who created the data asset.
- display
Name String - A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- display
Name StringContains - external
Key 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.
- type
Key String - The key of the object type. Type key's can be found via the '/types' endpoint.
Supporting Types
GetDataAssetsDataAssetCollection
- count Number
- items List<Property Map>
GetDataAssetsDataAssetCollectionItem
- Catalog
Id string - Unique catalog identifier.
- Created
By stringId - OCID of the user who created the resource.
- Description string
- Detailed description of the data asset.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- External
Key string - Unique external identifier of this resource in the external source system.
- Key string
- Unique data asset key that is immutable.
- Lifecycle
Details 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.
- Time
Created string - Time that the resource was created. An RFC3339 formatted datetime string.
- Time
Harvested string - The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
- Time
Updated string - Time that the resource was updated. An RFC3339 formatted datetime string.
- Type
Key string - The key of the object type.
- Updated
By stringId - OCID of the user who updated the resource.
- Uri string
- URI to the data asset instance in the API.
- Catalog
Id string - Unique catalog identifier.
- Created
By stringId - OCID of the user who created the resource.
- Description string
- Detailed description of the data asset.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- External
Key string - Unique external identifier of this resource in the external source system.
- Key string
- Unique data asset key that is immutable.
- Lifecycle
Details 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.
- Time
Created string - Time that the resource was created. An RFC3339 formatted datetime string.
- Time
Harvested string - The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
- Time
Updated string - Time that the resource was updated. An RFC3339 formatted datetime string.
- Type
Key string - The key of the object type.
- Updated
By stringId - OCID of the user who updated the resource.
- Uri string
- URI to the data asset instance in the API.
- catalog
Id String - Unique catalog identifier.
- created
By StringId - OCID of the user who created the resource.
- description String
- Detailed description of the data asset.
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- external
Key String - Unique external identifier of this resource in the external source system.
- key String
- Unique data asset key that is immutable.
- lifecycle
Details 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.
- time
Created String - Time that the resource was created. An RFC3339 formatted datetime string.
- time
Harvested String - The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
- time
Updated String - Time that the resource was updated. An RFC3339 formatted datetime string.
- type
Key String - The key of the object type.
- updated
By StringId - OCID of the user who updated the resource.
- uri String
- URI to the data asset instance in the API.
- catalog
Id string - Unique catalog identifier.
- created
By stringId - OCID of the user who created the resource.
- description string
- Detailed description of the data asset.
- display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- external
Key string - Unique external identifier of this resource in the external source system.
- key string
- Unique data asset key that is immutable.
- lifecycle
Details 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.
- time
Created string - Time that the resource was created. An RFC3339 formatted datetime string.
- time
Harvested string - The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
- time
Updated string - Time that the resource was updated. An RFC3339 formatted datetime string.
- type
Key string - The key of the object type.
- updated
By stringId - 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_ strid - 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_ strid - OCID of the user who updated the resource.
- uri str
- URI to the data asset instance in the API.
- catalog
Id String - Unique catalog identifier.
- created
By StringId - OCID of the user who created the resource.
- description String
- Detailed description of the data asset.
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- external
Key String - Unique external identifier of this resource in the external source system.
- key String
- Unique data asset key that is immutable.
- lifecycle
Details 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.
- time
Created String - Time that the resource was created. An RFC3339 formatted datetime string.
- time
Harvested String - The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.
- time
Updated String - Time that the resource was updated. An RFC3339 formatted datetime string.
- type
Key String - The key of the object type.
- updated
By StringId - OCID of the user who updated the resource.
- uri String
- URI to the data asset instance in the API.
GetDataAssetsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.