Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.DataCatalog.getCatalogs

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

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

const testCatalogs = oci.DataCatalog.getCatalogs({
    compartmentId: compartmentId,
    displayName: catalogDisplayName,
    state: catalogState,
});

import pulumi
import pulumi_oci as oci

test_catalogs = oci.DataCatalog.get_catalogs(compartment_id=compartment_id,
    display_name=catalog_display_name,
    state=catalog_state)

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.GetCatalogs(ctx, &datacatalog.GetCatalogsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(catalogDisplayName),
			State:         pulumi.StringRef(catalogState),
		}, 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 testCatalogs = Oci.DataCatalog.GetCatalogs.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = catalogDisplayName,
        State = catalogState,
    });

});

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.GetCatalogsArgs;
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 testCatalogs = DataCatalogFunctions.getCatalogs(GetCatalogsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(catalogDisplayName)
            .state(catalogState)
            .build());

    }
}

variables:
  testCatalogs:
    fn::invoke:
      function: oci:DataCatalog:getCatalogs
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${catalogDisplayName}
        state: ${catalogState}

Using getCatalogs

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 getCatalogs(args: GetCatalogsArgs, opts?: InvokeOptions): Promise<GetCatalogsResult>
function getCatalogsOutput(args: GetCatalogsOutputArgs, opts?: InvokeOptions): Output<GetCatalogsResult>

def get_catalogs(compartment_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 filters: Optional[Sequence[GetCatalogsFilter]] = None,
                 state: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetCatalogsResult
def get_catalogs_output(compartment_id: Optional[pulumi.Input[str]] = None,
                 display_name: Optional[pulumi.Input[str]] = None,
                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetCatalogsFilterArgs]]]] = None,
                 state: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetCatalogsResult]

func GetCatalogs(ctx *Context, args *GetCatalogsArgs, opts ...InvokeOption) (*GetCatalogsResult, error)
func GetCatalogsOutput(ctx *Context, args *GetCatalogsOutputArgs, opts ...InvokeOption) GetCatalogsResultOutput

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

public static class GetCatalogs 
{
    public static Task<GetCatalogsResult> InvokeAsync(GetCatalogsArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogsResult> Invoke(GetCatalogsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCatalogsResult> getCatalogs(GetCatalogsArgs args, InvokeOptions options)
public static Output<GetCatalogsResult> getCatalogs(GetCatalogsArgs args, InvokeOptions options)

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

The following arguments are supported:

CompartmentId string: The OCID of the compartment where you want to list resources.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters List<GetCatalogsFilter>
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

CompartmentId string: The OCID of the compartment where you want to list resources.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters []GetCatalogsFilter
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId String: The OCID of the compartment where you want to list resources.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters List<GetCatalogsFilter>
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId string: The OCID of the compartment where you want to list resources.
displayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters GetCatalogsFilter[]
state string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartment_id str: The OCID of the compartment where you want to list resources.
display_name str: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters Sequence[GetCatalogsFilter]
state str: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId String: The OCID of the compartment where you want to list resources.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters List<Property Map>
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

getCatalogs Result

The following output properties are available:

Catalogs List<GetCatalogsCatalog>: The list of catalogs.
CompartmentId string: Compartment identifier.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: Data catalog identifier, which can be renamed.
Filters List<GetCatalogsFilter>
State string: The current state of the data catalog resource.

Catalogs []GetCatalogsCatalog: The list of catalogs.
CompartmentId string: Compartment identifier.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: Data catalog identifier, which can be renamed.
Filters []GetCatalogsFilter
State string: The current state of the data catalog resource.

catalogs List<GetCatalogsCatalog>: The list of catalogs.
compartmentId String: Compartment identifier.
id String: The provider-assigned unique ID for this managed resource.
displayName String: Data catalog identifier, which can be renamed.
filters List<GetCatalogsFilter>
state String: The current state of the data catalog resource.

catalogs GetCatalogsCatalog[]: The list of catalogs.
compartmentId string: Compartment identifier.
id string: The provider-assigned unique ID for this managed resource.
displayName string: Data catalog identifier, which can be renamed.
filters GetCatalogsFilter[]
state string: The current state of the data catalog resource.

catalogs Sequence[GetCatalogsCatalog]: The list of catalogs.
compartment_id str: Compartment identifier.
id str: The provider-assigned unique ID for this managed resource.
display_name str: Data catalog identifier, which can be renamed.
filters Sequence[GetCatalogsFilter]
state str: The current state of the data catalog resource.

catalogs List<Property Map>: The list of catalogs.
compartmentId String: Compartment identifier.
id String: The provider-assigned unique ID for this managed resource.
displayName String: Data catalog identifier, which can be renamed.
filters List<Property Map>
state String: The current state of the data catalog resource.

Supporting Types

GetCatalogsCatalog

AttachedCatalogPrivateEndpoints List<string>: The list of private reverse connection endpoints attached to the catalog
CompartmentId string: The OCID of the compartment where you want to list resources.
DefinedTags Dictionary<string, string>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
FreeformTags Dictionary<string, string>: 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.
Locks List<GetCatalogsCatalogLock>: Locks associated with this resource.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
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
CompartmentId string: The OCID of the compartment where you want to list resources.
DefinedTags map[string]string: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
FreeformTags map[string]string: 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.
Locks []GetCatalogsCatalogLock: Locks associated with this resource.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
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
compartmentId String: The OCID of the compartment where you want to list resources.
definedTags Map<String,String>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
freeformTags Map<String,String>: 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.
locks List<GetCatalogsCatalogLock>: Locks associated with this resource.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
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
compartmentId string: The OCID of the compartment where you want to list resources.
definedTags {[key: string]: string}: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
freeformTags {[key: string]: string}: 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.
locks GetCatalogsCatalogLock[]: Locks associated with this resource.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
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
compartment_id str: The OCID of the compartment where you want to list resources.
defined_tags Mapping[str, str]: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
display_name str: A filter to return only resources that match the entire display name given. The match is not case sensitive.
freeform_tags Mapping[str, str]: 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.
locks Sequence[GetCatalogsCatalogLock]: Locks associated with this resource.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
system_tags Mapping[str, str]: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
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
compartmentId String: The OCID of the compartment where you want to list resources.
definedTags Map<String>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
freeformTags Map<String>: 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.
locks List<Property Map>: Locks associated with this resource.
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: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
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.

GetCatalogsCatalogLock

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The time the data catalog was created. An RFC3339 formatted datetime string.
Type string: Type of the lock.

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The time the data catalog was created. An RFC3339 formatted datetime string.
Type string: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The time the data catalog was created. An RFC3339 formatted datetime string.
type String: Type of the lock.

message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated string: The time the data catalog was created. An RFC3339 formatted datetime string.
type string: Type of the lock.

message str: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
related_resource_id str: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created str: The time the data catalog was created. An RFC3339 formatted datetime string.
type str: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The time the data catalog was created. An RFC3339 formatted datetime string.
type String: Type of the lock.

GetCatalogsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

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.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.DataCatalog.getCatalogs

On this page

On this page

Example Usage

Using getCatalogs

getCatalogs Result

Supporting Types

GetCatalogsCatalog

GetCatalogsCatalogLock

GetCatalogsFilter

Package Details

On this page

On this page