Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getCatalogs

This data source provides the list of Catalogs in Oracle Cloud Infrastructure Data Catalog service.

Returns a list of all the data catalogs in the specified compartment.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testCatalogs = Oci.DataCatalog.GetCatalogs.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.Catalog_display_name,
        State = @var.Catalog_state,
    });

});
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.GetCatalogs(ctx, &datacatalog.GetCatalogsArgs{
			CompartmentId: _var.Compartment_id,
			DisplayName:   pulumi.StringRef(_var.Catalog_display_name),
			State:         pulumi.StringRef(_var.Catalog_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
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(var_.compartment_id())
            .displayName(var_.catalog_display_name())
            .state(var_.catalog_state())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_catalogs = oci.DataCatalog.get_catalogs(compartment_id=var["compartment_id"],
    display_name=var["catalog_display_name"],
    state=var["catalog_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCatalogs = oci.DataCatalog.getCatalogs({
    compartmentId: _var.compartment_id,
    displayName: _var.catalog_display_name,
    state: _var.catalog_state,
});
variables:
  testCatalogs:
    Fn::Invoke:
      Function: oci:DataCatalog:getCatalogs
      Arguments:
        compartmentId: ${var.compartment_id}
        displayName: ${var.catalog_display_name}
        state: ${var.catalog_state}

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[_datacatalog.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[_datacatalog.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)
// Output-based functions aren't available in Java yet
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 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 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 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, object>

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, object>

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.

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.

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]interface{}

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]interface{}

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.

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.

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,Object>

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,Object>

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.

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.

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]: any}

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]: any}

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.

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.

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, Any]

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, Any]

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.

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.

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<Any>

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<Any>

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.

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.

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.

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
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.