Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.3.0 published on Tuesday, Aug 16, 2022 by Pulumi

getCatalog

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

Gets a data catalog by identifier.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testCatalog = Output.Create(Oci.DataCatalog.GetCatalog.InvokeAsync(new Oci.DataCatalog.GetCatalogArgs
        {
            CatalogId = oci_datacatalog_catalog.Test_catalog.Id,
        }));
    }

}
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.GetCatalog(ctx, &datacatalog.GetCatalogArgs{
			CatalogId: oci_datacatalog_catalog.Test_catalog.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_catalog = oci.DataCatalog.get_catalog(catalog_id=oci_datacatalog_catalog["test_catalog"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCatalog = oci.DataCatalog.getCatalog({
    catalogId: oci_datacatalog_catalog.test_catalog.id,
});

Coming soon!

Using getCatalog

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 getCatalog(args: GetCatalogArgs, opts?: InvokeOptions): Promise<GetCatalogResult>
function getCatalogOutput(args: GetCatalogOutputArgs, opts?: InvokeOptions): Output<GetCatalogResult>
def get_catalog(catalog_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetCatalogResult
def get_catalog_output(catalog_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetCatalogResult]
func GetCatalog(ctx *Context, args *GetCatalogArgs, opts ...InvokeOption) (*GetCatalogResult, error)
func GetCatalogOutput(ctx *Context, args *GetCatalogOutputArgs, opts ...InvokeOption) GetCatalogResultOutput

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

public static class GetCatalog 
{
    public static Task<GetCatalogResult> InvokeAsync(GetCatalogArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogResult> Invoke(GetCatalogInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCatalogResult> getCatalog(GetCatalogArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DataCatalog/getCatalog:getCatalog
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CatalogId string

Unique catalog identifier.

CatalogId string

Unique catalog identifier.

catalogId String

Unique catalog identifier.

catalogId string

Unique catalog identifier.

catalog_id str

Unique catalog identifier.

catalogId String

Unique catalog identifier.

getCatalog Result

The following output properties are available:

AttachedCatalogPrivateEndpoints List<string>

The list of private reverse connection endpoints attached to the catalog

CatalogId string
CompartmentId string

Compartment identifier.

DefinedTags Dictionary<string, object>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

Data catalog identifier, which can be renamed.

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.

LifecycleDetails string

An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.

NumberOfObjects int

The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.

ServiceApiUrl string

The REST front endpoint URL to the data catalog instance.

ServiceConsoleUrl string

The console front endpoint URL to the data catalog instance.

State string

The current state of the data catalog resource.

TimeCreated string

The time the data catalog was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the data catalog was updated. An RFC3339 formatted datetime string.

AttachedCatalogPrivateEndpoints []string

The list of private reverse connection endpoints attached to the catalog

CatalogId string
CompartmentId string

Compartment identifier.

DefinedTags map[string]interface{}

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

Data catalog identifier, which can be renamed.

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.

LifecycleDetails string

An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.

NumberOfObjects int

The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.

ServiceApiUrl string

The REST front endpoint URL to the data catalog instance.

ServiceConsoleUrl string

The console front endpoint URL to the data catalog instance.

State string

The current state of the data catalog resource.

TimeCreated string

The time the data catalog was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the data catalog was updated. An RFC3339 formatted datetime string.

attachedCatalogPrivateEndpoints List<String>

The list of private reverse connection endpoints attached to the catalog

catalogId String
compartmentId String

Compartment identifier.

definedTags Map<String,Object>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}

displayName String

Data catalog identifier, which can be renamed.

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.

lifecycleDetails String

An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.

numberOfObjects Integer

The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.

serviceApiUrl String

The REST front endpoint URL to the data catalog instance.

serviceConsoleUrl String

The console front endpoint URL to the data catalog instance.

state String

The current state of the data catalog resource.

timeCreated String

The time the data catalog was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the data catalog was updated. An RFC3339 formatted datetime string.

attachedCatalogPrivateEndpoints string[]

The list of private reverse connection endpoints attached to the catalog

catalogId string
compartmentId string

Compartment identifier.

definedTags {[key: string]: any}

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}

displayName string

Data catalog identifier, which can be renamed.

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.

lifecycleDetails string

An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.

numberOfObjects number

The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.

serviceApiUrl string

The REST front endpoint URL to the data catalog instance.

serviceConsoleUrl string

The console front endpoint URL to the data catalog instance.

state string

The current state of the data catalog resource.

timeCreated string

The time the data catalog was created. An RFC3339 formatted datetime string.

timeUpdated string

The time the data catalog was updated. An RFC3339 formatted datetime string.

attached_catalog_private_endpoints Sequence[str]

The list of private reverse connection endpoints attached to the catalog

catalog_id str
compartment_id str

Compartment identifier.

defined_tags Mapping[str, Any]

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}

display_name str

Data catalog identifier, which can be renamed.

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.

lifecycle_details str

An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.

number_of_objects int

The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.

service_api_url str

The REST front endpoint URL to the data catalog instance.

service_console_url str

The console front endpoint URL to the data catalog instance.

state str

The current state of the data catalog resource.

time_created str

The time the data catalog was created. An RFC3339 formatted datetime string.

time_updated str

The time the data catalog was updated. An RFC3339 formatted datetime string.

attachedCatalogPrivateEndpoints List<String>

The list of private reverse connection endpoints attached to the catalog

catalogId String
compartmentId String

Compartment identifier.

definedTags Map<Any>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}

displayName String

Data catalog identifier, which can be renamed.

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.

lifecycleDetails String

An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state.

numberOfObjects Number

The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.

serviceApiUrl String

The REST front endpoint URL to the data catalog instance.

serviceConsoleUrl String

The console front endpoint URL to the data catalog instance.

state String

The current state of the data catalog resource.

timeCreated String

The time the data catalog was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the data catalog was updated. An RFC3339 formatted datetime 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.