getCatalogType.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package datacatalog

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi-oci/sdk/go/oci/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// This data source provides details about a specific Catalog Type resource in Oracle Cloud Infrastructure Data Catalog service.
//
// Gets a specific type by key within a data catalog.
//
// ## Example Usage
//
// ```go
// 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.GetCatalogType(ctx, &datacatalog.GetCatalogTypeArgs{
//				CatalogId: testCatalog.Id,
//				TypeKey:   catalogTypeTypeKey,
//				Fields:    catalogTypeFields,
//			}, nil)
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
func GetCatalogType(ctx *pulumi.Context, args *GetCatalogTypeArgs, opts ...pulumi.InvokeOption) (*GetCatalogTypeResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv GetCatalogTypeResult
	err := ctx.Invoke("oci:DataCatalog/getCatalogType:getCatalogType", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getCatalogType.
type GetCatalogTypeArgs struct {
	// Unique catalog identifier.
	CatalogId string `pulumi:"catalogId"`
	// Specifies the fields to return in a type response.
	Fields []string `pulumi:"fields"`
	// Unique type key.
	TypeKey string `pulumi:"typeKey"`
}

// A collection of values returned by getCatalogType.
type GetCatalogTypeResult struct {
	// The data catalog's OCID.
	CatalogId string `pulumi:"catalogId"`
	// Detailed description of the type.
	Description string `pulumi:"description"`
	// Mapping type equivalence in the external system.
	ExternalTypeName string   `pulumi:"externalTypeName"`
	Fields           []string `pulumi:"fields"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Indicates whether the type is approved for use as a classifying object.
	IsApproved bool `pulumi:"isApproved"`
	// Indicates whether the type is internal, making it unavailable for use by metadata elements.
	IsInternal bool `pulumi:"isInternal"`
	// Indicates whether the type can be used for tagging metadata elements.
	IsTag bool `pulumi:"isTag"`
	// Unique type key that is immutable.
	Key string `pulumi:"key"`
	// The immutable name of the type.
	Name string `pulumi:"name"`
	// 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 }, ... ] } } }`
	Properties map[string]interface{} `pulumi:"properties"`
	// The current state of the type.
	State string `pulumi:"state"`
	// Indicates the category this type belongs to. For instance, data assets, connections.
	TypeCategory string `pulumi:"typeCategory"`
	TypeKey      string `pulumi:"typeKey"`
	// URI to the type instance in the API.
	Uri string `pulumi:"uri"`
}

func GetCatalogTypeOutput(ctx *pulumi.Context, args GetCatalogTypeOutputArgs, opts ...pulumi.InvokeOption) GetCatalogTypeResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (GetCatalogTypeResult, error) {
			args := v.(GetCatalogTypeArgs)
			r, err := GetCatalogType(ctx, &args, opts...)
			var s GetCatalogTypeResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(GetCatalogTypeResultOutput)
}

// A collection of arguments for invoking getCatalogType.
type GetCatalogTypeOutputArgs struct {
	// Unique catalog identifier.
	CatalogId pulumi.StringInput `pulumi:"catalogId"`
	// Specifies the fields to return in a type response.
	Fields pulumi.StringArrayInput `pulumi:"fields"`
	// Unique type key.
	TypeKey pulumi.StringInput `pulumi:"typeKey"`
}

func (GetCatalogTypeOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*GetCatalogTypeArgs)(nil)).Elem()
}

// A collection of values returned by getCatalogType.
type GetCatalogTypeResultOutput struct{ *pulumi.OutputState }

func (GetCatalogTypeResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*GetCatalogTypeResult)(nil)).Elem()
}

func (o GetCatalogTypeResultOutput) ToGetCatalogTypeResultOutput() GetCatalogTypeResultOutput {
	return o
}

func (o GetCatalogTypeResultOutput) ToGetCatalogTypeResultOutputWithContext(ctx context.Context) GetCatalogTypeResultOutput {
	return o
}

// The data catalog's OCID.
func (o GetCatalogTypeResultOutput) CatalogId() pulumi.StringOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) string { return v.CatalogId }).(pulumi.StringOutput)
}

// Detailed description of the type.
func (o GetCatalogTypeResultOutput) Description() pulumi.StringOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) string { return v.Description }).(pulumi.StringOutput)
}

// Mapping type equivalence in the external system.
func (o GetCatalogTypeResultOutput) ExternalTypeName() pulumi.StringOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) string { return v.ExternalTypeName }).(pulumi.StringOutput)
}

func (o GetCatalogTypeResultOutput) Fields() pulumi.StringArrayOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) []string { return v.Fields }).(pulumi.StringArrayOutput)
}

// The provider-assigned unique ID for this managed resource.
func (o GetCatalogTypeResultOutput) Id() pulumi.StringOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) string { return v.Id }).(pulumi.StringOutput)
}

// Indicates whether the type is approved for use as a classifying object.
func (o GetCatalogTypeResultOutput) IsApproved() pulumi.BoolOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) bool { return v.IsApproved }).(pulumi.BoolOutput)
}

// Indicates whether the type is internal, making it unavailable for use by metadata elements.
func (o GetCatalogTypeResultOutput) IsInternal() pulumi.BoolOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) bool { return v.IsInternal }).(pulumi.BoolOutput)
}

// Indicates whether the type can be used for tagging metadata elements.
func (o GetCatalogTypeResultOutput) IsTag() pulumi.BoolOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) bool { return v.IsTag }).(pulumi.BoolOutput)
}

// Unique type key that is immutable.
func (o GetCatalogTypeResultOutput) Key() pulumi.StringOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) string { return v.Key }).(pulumi.StringOutput)
}

// The immutable name of the type.
func (o GetCatalogTypeResultOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) string { return v.Name }).(pulumi.StringOutput)
}

// 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 }, ... ] } } }`
func (o GetCatalogTypeResultOutput) Properties() pulumi.MapOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) map[string]interface{} { return v.Properties }).(pulumi.MapOutput)
}

// The current state of the type.
func (o GetCatalogTypeResultOutput) State() pulumi.StringOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) string { return v.State }).(pulumi.StringOutput)
}

// Indicates the category this type belongs to. For instance, data assets, connections.
func (o GetCatalogTypeResultOutput) TypeCategory() pulumi.StringOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) string { return v.TypeCategory }).(pulumi.StringOutput)
}

func (o GetCatalogTypeResultOutput) TypeKey() pulumi.StringOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) string { return v.TypeKey }).(pulumi.StringOutput)
}

// URI to the type instance in the API.
func (o GetCatalogTypeResultOutput) Uri() pulumi.StringOutput {
	return o.ApplyT(func(v GetCatalogTypeResult) string { return v.Uri }).(pulumi.StringOutput)
}

func init() {
	pulumi.RegisterOutputType(GetCatalogTypeResultOutput{})
}