Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getDataAsset

This data source provides details about a specific Data Asset resource in Oracle Cloud Infrastructure Data Catalog service.

Gets a specific data asset for the given key within a data catalog.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDataAsset = Oci.DataCatalog.GetDataAsset.Invoke(new()
    {
        CatalogId = oci_datacatalog_catalog.Test_catalog.Id,
        DataAssetKey = @var.Data_asset_data_asset_key,
        Fields = @var.Data_asset_fields,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DataCatalog"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataCatalog.GetDataAsset(ctx, &datacatalog.GetDataAssetArgs{
			CatalogId:    oci_datacatalog_catalog.Test_catalog.Id,
			DataAssetKey: _var.Data_asset_data_asset_key,
			Fields:       _var.Data_asset_fields,
		}, 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.DataCatalog.DataCatalogFunctions;
import com.pulumi.oci.DataCatalog.inputs.GetDataAssetArgs;
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 testDataAsset = DataCatalogFunctions.getDataAsset(GetDataAssetArgs.builder()
            .catalogId(oci_datacatalog_catalog.test_catalog().id())
            .dataAssetKey(var_.data_asset_data_asset_key())
            .fields(var_.data_asset_fields())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_data_asset = oci.DataCatalog.get_data_asset(catalog_id=oci_datacatalog_catalog["test_catalog"]["id"],
    data_asset_key=var["data_asset_data_asset_key"],
    fields=var["data_asset_fields"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDataAsset = oci.DataCatalog.getDataAsset({
    catalogId: oci_datacatalog_catalog.test_catalog.id,
    dataAssetKey: _var.data_asset_data_asset_key,
    fields: _var.data_asset_fields,
});
variables:
  testDataAsset:
    Fn::Invoke:
      Function: oci:DataCatalog:getDataAsset
      Arguments:
        catalogId: ${oci_datacatalog_catalog.test_catalog.id}
        dataAssetKey: ${var.data_asset_data_asset_key}
        fields: ${var.data_asset_fields}

Using getDataAsset

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 getDataAsset(args: GetDataAssetArgs, opts?: InvokeOptions): Promise<GetDataAssetResult>
function getDataAssetOutput(args: GetDataAssetOutputArgs, opts?: InvokeOptions): Output<GetDataAssetResult>
def get_data_asset(catalog_id: Optional[str] = None,
                   data_asset_key: Optional[str] = None,
                   fields: Optional[Sequence[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDataAssetResult
def get_data_asset_output(catalog_id: Optional[pulumi.Input[str]] = None,
                   data_asset_key: Optional[pulumi.Input[str]] = None,
                   fields: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDataAssetResult]
func GetDataAsset(ctx *Context, args *GetDataAssetArgs, opts ...InvokeOption) (*GetDataAssetResult, error)
func GetDataAssetOutput(ctx *Context, args *GetDataAssetOutputArgs, opts ...InvokeOption) GetDataAssetResultOutput

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

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

The following arguments are supported:

CatalogId string

Unique catalog identifier.

DataAssetKey string

Unique data asset key.

Fields List<string>

Specifies the fields to return in a data asset response.

CatalogId string

Unique catalog identifier.

DataAssetKey string

Unique data asset key.

Fields []string

Specifies the fields to return in a data asset response.

catalogId String

Unique catalog identifier.

dataAssetKey String

Unique data asset key.

fields List<String>

Specifies the fields to return in a data asset response.

catalogId string

Unique catalog identifier.

dataAssetKey string

Unique data asset key.

fields string[]

Specifies the fields to return in a data asset response.

catalog_id str

Unique catalog identifier.

data_asset_key str

Unique data asset key.

fields Sequence[str]

Specifies the fields to return in a data asset response.

catalogId String

Unique catalog identifier.

dataAssetKey String

Unique data asset key.

fields List<String>

Specifies the fields to return in a data asset response.

getDataAsset Result

The following output properties are available:

CatalogId string

The data catalog's OCID.

CreatedById string

OCID of the user who created the data asset.

DataAssetKey string
Description string

Detailed description of the data asset.

DisplayName string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

ExternalKey string

External URI that can be used to reference the object. Format will differ based on the type of object.

Id string
Key string

Unique data asset key that is immutable.

Properties Dictionary<string, object>

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

The current state of the data asset.

TimeCreated string

The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

TimeHarvested string

The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.

TimeUpdated string

The last time that any change was made to the data asset. An RFC3339 formatted datetime string.

TypeKey string

The key of the object type. Type key's can be found via the '/types' endpoint.

UpdatedById string

OCID of the user who last modified the data asset.

Uri string

URI to the data asset instance in the API.

Fields List<string>
CatalogId string

The data catalog's OCID.

CreatedById string

OCID of the user who created the data asset.

DataAssetKey string
Description string

Detailed description of the data asset.

DisplayName string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

ExternalKey string

External URI that can be used to reference the object. Format will differ based on the type of object.

Id string
Key string

Unique data asset key that is immutable.

Properties map[string]interface{}

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

The current state of the data asset.

TimeCreated string

The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

TimeHarvested string

The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.

TimeUpdated string

The last time that any change was made to the data asset. An RFC3339 formatted datetime string.

TypeKey string

The key of the object type. Type key's can be found via the '/types' endpoint.

UpdatedById string

OCID of the user who last modified the data asset.

Uri string

URI to the data asset instance in the API.

Fields []string
catalogId String

The data catalog's OCID.

createdById String

OCID of the user who created the data asset.

dataAssetKey String
description String

Detailed description of the data asset.

displayName String

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

externalKey String

External URI that can be used to reference the object. Format will differ based on the type of object.

id String
key String

Unique data asset key that is immutable.

properties Map<String,Object>

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

The current state of the data asset.

timeCreated String

The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

timeHarvested String

The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.

timeUpdated String

The last time that any change was made to the data asset. An RFC3339 formatted datetime string.

typeKey String

The key of the object type. Type key's can be found via the '/types' endpoint.

updatedById String

OCID of the user who last modified the data asset.

uri String

URI to the data asset instance in the API.

fields List<String>
catalogId string

The data catalog's OCID.

createdById string

OCID of the user who created the data asset.

dataAssetKey string
description string

Detailed description of the data asset.

displayName string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

externalKey string

External URI that can be used to reference the object. Format will differ based on the type of object.

id string
key string

Unique data asset key that is immutable.

properties {[key: string]: any}

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

The current state of the data asset.

timeCreated string

The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

timeHarvested string

The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.

timeUpdated string

The last time that any change was made to the data asset. An RFC3339 formatted datetime string.

typeKey string

The key of the object type. Type key's can be found via the '/types' endpoint.

updatedById string

OCID of the user who last modified the data asset.

uri string

URI to the data asset instance in the API.

fields string[]
catalog_id str

The data catalog's OCID.

created_by_id str

OCID of the user who created the data asset.

data_asset_key str
description str

Detailed description of 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.

external_key str

External URI that can be used to reference the object. Format will differ based on the type of object.

id str
key str

Unique data asset key that is immutable.

properties Mapping[str, Any]

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

The current state of the data asset.

time_created str

The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

time_harvested str

The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.

time_updated str

The last time that any change was made to the data asset. An RFC3339 formatted datetime string.

type_key str

The key of the object type. Type key's can be found via the '/types' endpoint.

updated_by_id str

OCID of the user who last modified the data asset.

uri str

URI to the data asset instance in the API.

fields Sequence[str]
catalogId String

The data catalog's OCID.

createdById String

OCID of the user who created the data asset.

dataAssetKey String
description String

Detailed description of the data asset.

displayName String

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

externalKey String

External URI that can be used to reference the object. Format will differ based on the type of object.

id String
key String

Unique data asset key that is immutable.

properties Map<Any>

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

The current state of the data asset.

timeCreated String

The date and time the data asset was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

timeHarvested String

The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.

timeUpdated String

The last time that any change was made to the data asset. An RFC3339 formatted datetime string.

typeKey String

The key of the object type. Type key's can be found via the '/types' endpoint.

updatedById String

OCID of the user who last modified the data asset.

uri String

URI to the data asset instance in the API.

fields List<String>

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.