Oracle Cloud Infrastructure v2.15.0 published on Thursday, Oct 31, 2024 by Pulumi
oci.DataCatalog.getCatalogTypes
Explore with Pulumi AI
This data source provides the list of Catalog Types in Oracle Cloud Infrastructure Data Catalog service.
Returns a list of all types within a data catalog.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:DataCatalog/getCatalogTypes:getCatalogTypes
arguments:
# arguments dictionary
The following arguments are supported:
- Catalog
Id string - Unique catalog identifier.
- External
Type stringName - Data type as defined in an external system.
- Fields List<string>
- Specifies the fields to return in a type summary response.
- Filters
List<Get
Catalog Types Filter> - Is
Approved string - Indicates whether the type is approved for use as a classifying object.
- Is
Internal string - Indicates whether the type is internal, making it unavailable for use by metadata elements.
- Is
Tag 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.
- Type
Category string - Indicates the category of this type . For example, data assets or connections.
- Catalog
Id string - Unique catalog identifier.
- External
Type stringName - Data type as defined in an external system.
- Fields []string
- Specifies the fields to return in a type summary response.
- Filters
[]Get
Catalog Types Filter - Is
Approved string - Indicates whether the type is approved for use as a classifying object.
- Is
Internal string - Indicates whether the type is internal, making it unavailable for use by metadata elements.
- Is
Tag 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.
- Type
Category string - Indicates the category of this type . For example, data assets or connections.
- catalog
Id String - Unique catalog identifier.
- external
Type StringName - Data type as defined in an external system.
- fields List<String>
- Specifies the fields to return in a type summary response.
- filters
List<Get
Catalog Types Filter> - is
Approved String - Indicates whether the type is approved for use as a classifying object.
- is
Internal String - Indicates whether the type is internal, making it unavailable for use by metadata elements.
- is
Tag 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.
- type
Category String - Indicates the category of this type . For example, data assets or connections.
- catalog
Id string - Unique catalog identifier.
- external
Type stringName - Data type as defined in an external system.
- fields string[]
- Specifies the fields to return in a type summary response.
- filters
Get
Catalog Types Filter[] - is
Approved string - Indicates whether the type is approved for use as a classifying object.
- is
Internal string - Indicates whether the type is internal, making it unavailable for use by metadata elements.
- is
Tag 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.
- type
Category string - Indicates the category of this type . For example, data assets or connections.
- catalog_
id str - Unique catalog identifier.
- external_
type_ strname - Data type as defined in an external system.
- fields Sequence[str]
- Specifies the fields to return in a type summary response.
- filters
Sequence[datacatalog.
Get Catalog Types Filter] - 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.
- catalog
Id String - Unique catalog identifier.
- external
Type StringName - 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>
- is
Approved String - Indicates whether the type is approved for use as a classifying object.
- is
Internal String - Indicates whether the type is internal, making it unavailable for use by metadata elements.
- is
Tag 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.
- type
Category String - Indicates the category of this type . For example, data assets or connections.
getCatalogTypes Result
The following output properties are available:
- Catalog
Id string - The data catalog's OCID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Type
Collections List<GetCatalog Types Type Collection> - The list of type_collection.
- External
Type stringName - Mapping type equivalence in the external system.
- Fields List<string>
- Filters
List<Get
Catalog Types Filter> - Is
Approved string - Indicates whether the type is approved for use as a classifying object.
- Is
Internal string - Indicates whether the type is internal, making it unavailable for use by metadata elements.
- Is
Tag 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.
- Type
Category string - Indicates the category this type belongs to. For instance, data assets, connections.
- Catalog
Id string - The data catalog's OCID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Type
Collections []GetCatalog Types Type Collection - The list of type_collection.
- External
Type stringName - Mapping type equivalence in the external system.
- Fields []string
- Filters
[]Get
Catalog Types Filter - Is
Approved string - Indicates whether the type is approved for use as a classifying object.
- Is
Internal string - Indicates whether the type is internal, making it unavailable for use by metadata elements.
- Is
Tag 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.
- Type
Category string - Indicates the category this type belongs to. For instance, data assets, connections.
- catalog
Id String - The data catalog's OCID.
- id String
- The provider-assigned unique ID for this managed resource.
- type
Collections List<GetCatalog Types Type Collection> - The list of type_collection.
- external
Type StringName - Mapping type equivalence in the external system.
- fields List<String>
- filters
List<Get
Catalog Types Filter> - is
Approved String - Indicates whether the type is approved for use as a classifying object.
- is
Internal String - Indicates whether the type is internal, making it unavailable for use by metadata elements.
- is
Tag 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.
- type
Category String - Indicates the category this type belongs to. For instance, data assets, connections.
- catalog
Id string - The data catalog's OCID.
- id string
- The provider-assigned unique ID for this managed resource.
- type
Collections GetCatalog Types Type Collection[] - The list of type_collection.
- external
Type stringName - Mapping type equivalence in the external system.
- fields string[]
- filters
Get
Catalog Types Filter[] - is
Approved string - Indicates whether the type is approved for use as a classifying object.
- is
Internal string - Indicates whether the type is internal, making it unavailable for use by metadata elements.
- is
Tag 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.
- type
Category 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.Get Catalog Types Type Collection] - The list of type_collection.
- external_
type_ strname - Mapping type equivalence in the external system.
- fields Sequence[str]
- filters
Sequence[datacatalog.
Get Catalog Types Filter] - 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.
- catalog
Id String - The data catalog's OCID.
- id String
- The provider-assigned unique ID for this managed resource.
- type
Collections List<Property Map> - The list of type_collection.
- external
Type StringName - Mapping type equivalence in the external system.
- fields List<String>
- filters List<Property Map>
- is
Approved String - Indicates whether the type is approved for use as a classifying object.
- is
Internal String - Indicates whether the type is internal, making it unavailable for use by metadata elements.
- is
Tag 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.
- type
Category String - Indicates the category this type belongs to. For instance, data assets, connections.
Supporting Types
GetCatalogTypesFilter
GetCatalogTypesTypeCollection
- count Number
- items List<Property Map>
GetCatalogTypesTypeCollectionItem
- Catalog
Id 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.
- Type
Category 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 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.
- Type
Category 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 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.
- type
Category 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 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.
- type
Category 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.
- catalog
Id 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.
- type
Category 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.