Oracle Cloud Infrastructure v2.27.0, Mar 20 25

Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi

oci.DataCatalog.getCatalogTypes

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCatalogTypes = oci.DataCatalog.getCatalogTypes({
    catalogId: testCatalog.id,
    externalTypeName: catalogTypeExternalTypeName,
    fields: catalogTypeFields,
    isApproved: catalogTypeIsApproved,
    isInternal: catalogTypeIsInternal,
    isTag: catalogTypeIsTag,
    name: catalogTypeName,
    state: catalogTypeState,
    typeCategory: catalogTypeTypeCategory,
});

import pulumi
import pulumi_oci as oci

test_catalog_types = oci.DataCatalog.get_catalog_types(catalog_id=test_catalog["id"],
    external_type_name=catalog_type_external_type_name,
    fields=catalog_type_fields,
    is_approved=catalog_type_is_approved,
    is_internal=catalog_type_is_internal,
    is_tag=catalog_type_is_tag,
    name=catalog_type_name,
    state=catalog_type_state,
    type_category=catalog_type_type_category)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datacatalog.GetCatalogTypes(ctx, &datacatalog.GetCatalogTypesArgs{
			CatalogId:        testCatalog.Id,
			ExternalTypeName: pulumi.StringRef(catalogTypeExternalTypeName),
			Fields:           catalogTypeFields,
			IsApproved:       pulumi.StringRef(catalogTypeIsApproved),
			IsInternal:       pulumi.StringRef(catalogTypeIsInternal),
			IsTag:            pulumi.StringRef(catalogTypeIsTag),
			Name:             pulumi.StringRef(catalogTypeName),
			State:            pulumi.StringRef(catalogTypeState),
			TypeCategory:     pulumi.StringRef(catalogTypeTypeCategory),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testCatalogTypes = Oci.DataCatalog.GetCatalogTypes.Invoke(new()
    {
        CatalogId = testCatalog.Id,
        ExternalTypeName = catalogTypeExternalTypeName,
        Fields = catalogTypeFields,
        IsApproved = catalogTypeIsApproved,
        IsInternal = catalogTypeIsInternal,
        IsTag = catalogTypeIsTag,
        Name = catalogTypeName,
        State = catalogTypeState,
        TypeCategory = catalogTypeTypeCategory,
    });

});

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.GetCatalogTypesArgs;
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 testCatalogTypes = DataCatalogFunctions.getCatalogTypes(GetCatalogTypesArgs.builder()
            .catalogId(testCatalog.id())
            .externalTypeName(catalogTypeExternalTypeName)
            .fields(catalogTypeFields)
            .isApproved(catalogTypeIsApproved)
            .isInternal(catalogTypeIsInternal)
            .isTag(catalogTypeIsTag)
            .name(catalogTypeName)
            .state(catalogTypeState)
            .typeCategory(catalogTypeTypeCategory)
            .build());

    }
}

variables:
  testCatalogTypes:
    fn::invoke:
      function: oci:DataCatalog:getCatalogTypes
      arguments:
        catalogId: ${testCatalog.id}
        externalTypeName: ${catalogTypeExternalTypeName}
        fields: ${catalogTypeFields}
        isApproved: ${catalogTypeIsApproved}
        isInternal: ${catalogTypeIsInternal}
        isTag: ${catalogTypeIsTag}
        name: ${catalogTypeName}
        state: ${catalogTypeState}
        typeCategory: ${catalogTypeTypeCategory}

Using getCatalogTypes

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 getCatalogTypes(args: GetCatalogTypesArgs, opts?: InvokeOptions): Promise<GetCatalogTypesResult>
function getCatalogTypesOutput(args: GetCatalogTypesOutputArgs, opts?: InvokeOptions): Output<GetCatalogTypesResult>

def get_catalog_types(catalog_id: Optional[str] = None,
                      external_type_name: Optional[str] = None,
                      fields: Optional[Sequence[str]] = None,
                      filters: Optional[Sequence[_datacatalog.GetCatalogTypesFilter]] = None,
                      is_approved: Optional[str] = None,
                      is_internal: Optional[str] = None,
                      is_tag: Optional[str] = None,
                      name: Optional[str] = None,
                      state: Optional[str] = None,
                      type_category: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCatalogTypesResult
def get_catalog_types_output(catalog_id: Optional[pulumi.Input[str]] = None,
                      external_type_name: Optional[pulumi.Input[str]] = None,
                      fields: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datacatalog.GetCatalogTypesFilterArgs]]]] = None,
                      is_approved: Optional[pulumi.Input[str]] = None,
                      is_internal: Optional[pulumi.Input[str]] = None,
                      is_tag: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      state: Optional[pulumi.Input[str]] = None,
                      type_category: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCatalogTypesResult]

func GetCatalogTypes(ctx *Context, args *GetCatalogTypesArgs, opts ...InvokeOption) (*GetCatalogTypesResult, error)
func GetCatalogTypesOutput(ctx *Context, args *GetCatalogTypesOutputArgs, opts ...InvokeOption) GetCatalogTypesResultOutput

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

public static class GetCatalogTypes 
{
    public static Task<GetCatalogTypesResult> InvokeAsync(GetCatalogTypesArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogTypesResult> Invoke(GetCatalogTypesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCatalogTypesResult> getCatalogTypes(GetCatalogTypesArgs args, InvokeOptions options)
public static Output<GetCatalogTypesResult> getCatalogTypes(GetCatalogTypesArgs args, InvokeOptions options)

fn::invoke:
  function: oci:DataCatalog/getCatalogTypes:getCatalogTypes
  arguments:
    # arguments dictionary

The following arguments are supported:

CatalogId string: Unique catalog identifier.
ExternalTypeName string: Data type as defined in an external system.
Fields List<string>: Specifies the fields to return in a type summary response.
Filters List<GetCatalogTypesFilter>
IsApproved string: Indicates whether the type is approved for use as a classifying object.
IsInternal string: Indicates whether the type is internal, making it unavailable for use by metadata elements.
IsTag string: Indicates whether the type can be used for tagging metadata elements.
Name string: Immutable resource name.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TypeCategory string: Indicates the category of this type . For example, data assets or connections.

CatalogId string: Unique catalog identifier.
ExternalTypeName string: Data type as defined in an external system.
Fields []string: Specifies the fields to return in a type summary response.
Filters []GetCatalogTypesFilter
IsApproved string: Indicates whether the type is approved for use as a classifying object.
IsInternal string: Indicates whether the type is internal, making it unavailable for use by metadata elements.
IsTag string: Indicates whether the type can be used for tagging metadata elements.
Name string: Immutable resource name.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TypeCategory string: Indicates the category of this type . For example, data assets or connections.

catalogId String: Unique catalog identifier.
externalTypeName String: Data type as defined in an external system.
fields List<String>: Specifies the fields to return in a type summary response.
filters List<GetCatalogTypesFilter>
isApproved String: Indicates whether the type is approved for use as a classifying object.
isInternal String: Indicates whether the type is internal, making it unavailable for use by metadata elements.
isTag String: Indicates whether the type can be used for tagging metadata elements.
name String: Immutable resource name.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
typeCategory String: Indicates the category of this type . For example, data assets or connections.

catalogId string: Unique catalog identifier.
externalTypeName string: Data type as defined in an external system.
fields string[]: Specifies the fields to return in a type summary response.
filters GetCatalogTypesFilter[]
isApproved string: Indicates whether the type is approved for use as a classifying object.
isInternal string: Indicates whether the type is internal, making it unavailable for use by metadata elements.
isTag string: Indicates whether the type can be used for tagging metadata elements.
name string: Immutable resource name.
state string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
typeCategory string: Indicates the category of this type . For example, data assets or connections.

catalog_id str: Unique catalog identifier.
external_type_name str: Data type as defined in an external system.
fields Sequence[str]: Specifies the fields to return in a type summary response.
filters Sequence[datacatalog.GetCatalogTypesFilter]
is_approved str: Indicates whether the type is approved for use as a classifying object.
is_internal str: Indicates whether the type is internal, making it unavailable for use by metadata elements.
is_tag str: Indicates whether the type can be used for tagging metadata elements.
name str: Immutable resource name.
state str: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
type_category str: Indicates the category of this type . For example, data assets or connections.

catalogId String: Unique catalog identifier.
externalTypeName String: Data type as defined in an external system.
fields List<String>: Specifies the fields to return in a type summary response.
filters List<Property Map>
isApproved String: Indicates whether the type is approved for use as a classifying object.
isInternal String: Indicates whether the type is internal, making it unavailable for use by metadata elements.
isTag String: Indicates whether the type can be used for tagging metadata elements.
name String: Immutable resource name.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
typeCategory String: Indicates the category of this type . For example, data assets or connections.

getCatalogTypes Result

The following output properties are available:

CatalogId string: The data catalog's OCID.
Id string: The provider-assigned unique ID for this managed resource.
TypeCollections List<GetCatalogTypesTypeCollection>: The list of type_collection.
ExternalTypeName string: Mapping type equivalence in the external system.
Fields List<string>
Filters List<GetCatalogTypesFilter>
IsApproved string: Indicates whether the type is approved for use as a classifying object.
IsInternal string: Indicates whether the type is internal, making it unavailable for use by metadata elements.
IsTag string: Indicates whether the type can be used for tagging metadata elements.
Name string: The immutable name of the type.
State string: The current state of the type.
TypeCategory string: Indicates the category this type belongs to. For instance, data assets, connections.

CatalogId string: The data catalog's OCID.
Id string: The provider-assigned unique ID for this managed resource.
TypeCollections []GetCatalogTypesTypeCollection: The list of type_collection.
ExternalTypeName string: Mapping type equivalence in the external system.
Fields []string
Filters []GetCatalogTypesFilter
IsApproved string: Indicates whether the type is approved for use as a classifying object.
IsInternal string: Indicates whether the type is internal, making it unavailable for use by metadata elements.
IsTag string: Indicates whether the type can be used for tagging metadata elements.
Name string: The immutable name of the type.
State string: The current state of the type.
TypeCategory string: Indicates the category this type belongs to. For instance, data assets, connections.

catalogId String: The data catalog's OCID.
id String: The provider-assigned unique ID for this managed resource.
typeCollections List<GetCatalogTypesTypeCollection>: The list of type_collection.
externalTypeName String: Mapping type equivalence in the external system.
fields List<String>
filters List<GetCatalogTypesFilter>
isApproved String: Indicates whether the type is approved for use as a classifying object.
isInternal String: Indicates whether the type is internal, making it unavailable for use by metadata elements.
isTag String: Indicates whether the type can be used for tagging metadata elements.
name String: The immutable name of the type.
state String: The current state of the type.
typeCategory String: Indicates the category this type belongs to. For instance, data assets, connections.

catalogId string: The data catalog's OCID.
id string: The provider-assigned unique ID for this managed resource.
typeCollections GetCatalogTypesTypeCollection[]: The list of type_collection.
externalTypeName string: Mapping type equivalence in the external system.
fields string[]
filters GetCatalogTypesFilter[]
isApproved string: Indicates whether the type is approved for use as a classifying object.
isInternal string: Indicates whether the type is internal, making it unavailable for use by metadata elements.
isTag string: Indicates whether the type can be used for tagging metadata elements.
name string: The immutable name of the type.
state string: The current state of the type.
typeCategory string: Indicates the category this type belongs to. For instance, data assets, connections.

catalog_id str: The data catalog's OCID.
id str: The provider-assigned unique ID for this managed resource.
type_collections Sequence[datacatalog.GetCatalogTypesTypeCollection]: The list of type_collection.
external_type_name str: Mapping type equivalence in the external system.
fields Sequence[str]
filters Sequence[datacatalog.GetCatalogTypesFilter]
is_approved str: Indicates whether the type is approved for use as a classifying object.
is_internal str: Indicates whether the type is internal, making it unavailable for use by metadata elements.
is_tag str: Indicates whether the type can be used for tagging metadata elements.
name str: The immutable name of the type.
state str: The current state of the type.
type_category str: Indicates the category this type belongs to. For instance, data assets, connections.

catalogId String: The data catalog's OCID.
id String: The provider-assigned unique ID for this managed resource.
typeCollections List<Property Map>: The list of type_collection.
externalTypeName String: Mapping type equivalence in the external system.
fields List<String>
filters List<Property Map>
isApproved String: Indicates whether the type is approved for use as a classifying object.
isInternal String: Indicates whether the type is internal, making it unavailable for use by metadata elements.
isTag String: Indicates whether the type can be used for tagging metadata elements.
name String: The immutable name of the type.
state String: The current state of the type.
typeCategory String: Indicates the category this type belongs to. For instance, data assets, connections.

Supporting Types

GetCatalogTypesFilter

Name string: Immutable resource name.
Values List<string>
Regex bool

Name string: Immutable resource name.
Values []string
Regex bool

name String: Immutable resource name.
values List<String>
regex Boolean

name string: Immutable resource name.
values string[]
regex boolean

name str: Immutable resource name.
values Sequence[str]
regex bool

name String: Immutable resource name.
values List<String>
regex Boolean

GetCatalogTypesTypeCollection

Count int
Items List<GetCatalogTypesTypeCollectionItem>

Count int
Items []GetCatalogTypesTypeCollectionItem

count Integer
items List<GetCatalogTypesTypeCollectionItem>

count number
items GetCatalogTypesTypeCollectionItem[]

count int
items Sequence[datacatalog.GetCatalogTypesTypeCollectionItem]

count Number
items List<Property Map>

GetCatalogTypesTypeCollectionItem

CatalogId string: Unique catalog identifier.
Description string: Detailed description of the type.
Key string: Unique type key that is immutable.
Name string: Immutable resource name.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TypeCategory string: Indicates the category of this type . For example, data assets or connections.
Uri string: URI to the type instance in the API.

CatalogId string: Unique catalog identifier.
Description string: Detailed description of the type.
Key string: Unique type key that is immutable.
Name string: Immutable resource name.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
TypeCategory string: Indicates the category of this type . For example, data assets or connections.
Uri string: URI to the type instance in the API.

catalogId String: Unique catalog identifier.
description String: Detailed description of the type.
key String: Unique type key that is immutable.
name String: Immutable resource name.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
typeCategory String: Indicates the category of this type . For example, data assets or connections.
uri String: URI to the type instance in the API.

catalogId string: Unique catalog identifier.
description string: Detailed description of the type.
key string: Unique type key that is immutable.
name string: Immutable resource name.
state string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
typeCategory string: Indicates the category of this type . For example, data assets or connections.
uri string: URI to the type instance in the API.

catalog_id str: Unique catalog identifier.
description str: Detailed description of the type.
key str: Unique type key that is immutable.
name str: Immutable resource name.
state str: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
type_category str: Indicates the category of this type . For example, data assets or connections.
uri str: URI to the type instance in the API.

catalogId String: Unique catalog identifier.
description String: Detailed description of the type.
key String: Unique type key that is immutable.
name String: Immutable resource name.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
typeCategory String: Indicates the category of this type . For example, data assets or connections.
uri String: URI to the type instance in the API.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi

pulumi/pulumi-oci

oci.DataCatalog.getCatalogTypes

On this page

On this page

Example Usage

Using getCatalogTypes

getCatalogTypes Result

Supporting Types

GetCatalogTypesFilter

GetCatalogTypesTypeCollection

GetCatalogTypesTypeCollectionItem

Package Details

On this page

On this page