oci.DataCatalog.getCatalogType

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testCatalogType = oci.DataCatalog.getCatalogType({
    catalogId: testCatalog.id,
    typeKey: catalogTypeTypeKey,
    fields: catalogTypeFields,
});

import pulumi
import pulumi_oci as oci

test_catalog_type = oci.DataCatalog.get_catalog_type(catalog_id=test_catalog["id"],
    type_key=catalog_type_type_key,
    fields=catalog_type_fields)

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.GetCatalogType(ctx, &datacatalog.GetCatalogTypeArgs{
			CatalogId: testCatalog.Id,
			TypeKey:   catalogTypeTypeKey,
			Fields:    catalogTypeFields,
		}, 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 testCatalogType = Oci.DataCatalog.GetCatalogType.Invoke(new()
    {
        CatalogId = testCatalog.Id,
        TypeKey = catalogTypeTypeKey,
        Fields = catalogTypeFields,
    });

});

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.GetCatalogTypeArgs;
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 testCatalogType = DataCatalogFunctions.getCatalogType(GetCatalogTypeArgs.builder()
            .catalogId(testCatalog.id())
            .typeKey(catalogTypeTypeKey)
            .fields(catalogTypeFields)
            .build());

    }
}

variables:
  testCatalogType:
    fn::invoke:
      function: oci:DataCatalog:getCatalogType
      arguments:
        catalogId: ${testCatalog.id}
        typeKey: ${catalogTypeTypeKey}
        fields: ${catalogTypeFields}

Using getCatalogType

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.

TypeScript
Python
Go
C#
Java
YAML

function getCatalogType(args: GetCatalogTypeArgs, opts?: InvokeOptions): Promise<GetCatalogTypeResult>
function getCatalogTypeOutput(args: GetCatalogTypeOutputArgs, opts?: InvokeOptions): Output<GetCatalogTypeResult>

def get_catalog_type(catalog_id: Optional[str] = None,
                     fields: Optional[Sequence[str]] = None,
                     type_key: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCatalogTypeResult
def get_catalog_type_output(catalog_id: Optional[pulumi.Input[str]] = None,
                     fields: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     type_key: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetCatalogTypeResult]

func GetCatalogType(ctx *Context, args *GetCatalogTypeArgs, opts ...InvokeOption) (*GetCatalogTypeResult, error)
func GetCatalogTypeOutput(ctx *Context, args *GetCatalogTypeOutputArgs, opts ...InvokeOption) GetCatalogTypeResultOutput

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

public static class GetCatalogType 
{
    public static Task<GetCatalogTypeResult> InvokeAsync(GetCatalogTypeArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogTypeResult> Invoke(GetCatalogTypeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCatalogTypeResult> getCatalogType(GetCatalogTypeArgs args, InvokeOptions options)
public static Output<GetCatalogTypeResult> getCatalogType(GetCatalogTypeArgs args, InvokeOptions options)

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

The following arguments are supported:

CatalogId string: Unique catalog identifier.
TypeKey string: Unique type key.
Fields List<string>: Specifies the fields to return in a type response.

CatalogId string: Unique catalog identifier.
TypeKey string: Unique type key.
Fields []string: Specifies the fields to return in a type response.

catalogId String: Unique catalog identifier.
typeKey String: Unique type key.
fields List<String>: Specifies the fields to return in a type response.

catalogId string: Unique catalog identifier.
typeKey string: Unique type key.
fields string[]: Specifies the fields to return in a type response.

catalog_id str: Unique catalog identifier.
type_key str: Unique type key.
fields Sequence[str]: Specifies the fields to return in a type response.

catalogId String: Unique catalog identifier.
typeKey String: Unique type key.
fields List<String>: Specifies the fields to return in a type response.

getCatalogType Result

The following output properties are available:

CatalogId string: The data catalog's OCID.
Description string: Detailed description of the type.
ExternalTypeName string: Mapping type equivalence in the external system.
Id string: The provider-assigned unique ID for this managed resource.
IsApproved bool: Indicates whether the type is approved for use as a classifying object.
IsInternal bool: Indicates whether the type is internal, making it unavailable for use by metadata elements.
IsTag bool: Indicates whether the type can be used for tagging metadata elements.
Key string: Unique type key that is immutable.
Name string: The immutable name of the type.
Properties Dictionary<string, string>: A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the "default" category. Example: { "properties": { "default": { "attributes:": [ { "name": "host", "type": "string", "isRequired": true, "isUpdatable": false }, ... ] } } }
State string: The current state of the type.
TypeCategory string: Indicates the category this type belongs to. For instance, data assets, connections.
TypeKey string
Uri string: URI to the type instance in the API.
Fields List<string>

CatalogId string: The data catalog's OCID.
Description string: Detailed description of the type.
ExternalTypeName string: Mapping type equivalence in the external system.
Id string: The provider-assigned unique ID for this managed resource.
IsApproved bool: Indicates whether the type is approved for use as a classifying object.
IsInternal bool: Indicates whether the type is internal, making it unavailable for use by metadata elements.
IsTag bool: Indicates whether the type can be used for tagging metadata elements.
Key string: Unique type key that is immutable.
Name string: The immutable name of the type.
Properties map[string]string: A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the "default" category. Example: { "properties": { "default": { "attributes:": [ { "name": "host", "type": "string", "isRequired": true, "isUpdatable": false }, ... ] } } }
State string: The current state of the type.
TypeCategory string: Indicates the category this type belongs to. For instance, data assets, connections.
TypeKey string
Uri string: URI to the type instance in the API.
Fields []string

catalogId String: The data catalog's OCID.
description String: Detailed description of the type.
externalTypeName String: Mapping type equivalence in the external system.
id String: The provider-assigned unique ID for this managed resource.
isApproved Boolean: Indicates whether the type is approved for use as a classifying object.
isInternal Boolean: Indicates whether the type is internal, making it unavailable for use by metadata elements.
isTag Boolean: Indicates whether the type can be used for tagging metadata elements.
key String: Unique type key that is immutable.
name String: The immutable name of the type.
properties Map<String,String>: A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the "default" category. Example: { "properties": { "default": { "attributes:": [ { "name": "host", "type": "string", "isRequired": true, "isUpdatable": false }, ... ] } } }
state String: The current state of the type.
typeCategory String: Indicates the category this type belongs to. For instance, data assets, connections.
typeKey String
uri String: URI to the type instance in the API.
fields List<String>

catalogId string: The data catalog's OCID.
description string: Detailed description of the type.
externalTypeName string: Mapping type equivalence in the external system.
id string: The provider-assigned unique ID for this managed resource.
isApproved boolean: Indicates whether the type is approved for use as a classifying object.
isInternal boolean: Indicates whether the type is internal, making it unavailable for use by metadata elements.
isTag boolean: Indicates whether the type can be used for tagging metadata elements.
key string: Unique type key that is immutable.
name string: The immutable name of the type.
properties {[key: string]: string}: A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the "default" category. Example: { "properties": { "default": { "attributes:": [ { "name": "host", "type": "string", "isRequired": true, "isUpdatable": false }, ... ] } } }
state string: The current state of the type.
typeCategory string: Indicates the category this type belongs to. For instance, data assets, connections.
typeKey string
uri string: URI to the type instance in the API.
fields string[]

catalog_id str: The data catalog's OCID.
description str: Detailed description of the type.
external_type_name str: Mapping type equivalence in the external system.
id str: The provider-assigned unique ID for this managed resource.
is_approved bool: Indicates whether the type is approved for use as a classifying object.
is_internal bool: Indicates whether the type is internal, making it unavailable for use by metadata elements.
is_tag bool: Indicates whether the type can be used for tagging metadata elements.
key str: Unique type key that is immutable.
name str: The immutable name of the type.
properties Mapping[str, str]: A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the "default" category. Example: { "properties": { "default": { "attributes:": [ { "name": "host", "type": "string", "isRequired": true, "isUpdatable": false }, ... ] } } }
state str: The current state of the type.
type_category str: Indicates the category this type belongs to. For instance, data assets, connections.
type_key str
uri str: URI to the type instance in the API.
fields Sequence[str]

catalogId String: The data catalog's OCID.
description String: Detailed description of the type.
externalTypeName String: Mapping type equivalence in the external system.
id String: The provider-assigned unique ID for this managed resource.
isApproved Boolean: Indicates whether the type is approved for use as a classifying object.
isInternal Boolean: Indicates whether the type is internal, making it unavailable for use by metadata elements.
isTag Boolean: Indicates whether the type can be used for tagging metadata elements.
key String: Unique type key that is immutable.
name String: The immutable name of the type.
properties Map<String>: A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the "default" category. Example: { "properties": { "default": { "attributes:": [ { "name": "host", "type": "string", "isRequired": true, "isUpdatable": false }, ... ] } } }
state String: The current state of the type.
typeCategory String: Indicates the category this type belongs to. For instance, data assets, connections.
typeKey String
uri String: URI to the type instance in the API.
fields List<String>

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.30.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-oci

oci.DataCatalog.getCatalogType

On this page

On this page

Example Usage

Using getCatalogType

getCatalogType Result

Package Details

On this page

On this page