Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi
oci.DataCatalog.getCatalogs
Explore with Pulumi AI
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
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[_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:
- Compartment
Id string - The OCID of the compartment where you want to list resources.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Filters
List<Get
Catalogs Filter> - State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- Compartment
Id string - The OCID of the compartment where you want to list resources.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Filters
[]Get
Catalogs Filter - State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id String - The OCID of the compartment where you want to list resources.
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
List<Get
Catalogs Filter> - state String
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id string - The OCID of the compartment where you want to list resources.
- display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
Get
Catalogs Filter[] - 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[datacatalog.
Get Catalogs Filter] - state str
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id String - The OCID of the compartment where you want to list resources.
- display
Name 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<Get
Catalogs Catalog> - The list of catalogs.
- Compartment
Id string - Compartment identifier.
- Id string
- The provider-assigned unique ID for this managed resource.
- Display
Name string - Data catalog identifier, which can be renamed.
- Filters
List<Get
Catalogs Filter> - State string
- The current state of the data catalog resource.
- Catalogs
[]Get
Catalogs Catalog - The list of catalogs.
- Compartment
Id string - Compartment identifier.
- Id string
- The provider-assigned unique ID for this managed resource.
- Display
Name string - Data catalog identifier, which can be renamed.
- Filters
[]Get
Catalogs Filter - State string
- The current state of the data catalog resource.
- catalogs
List<Get
Catalogs Catalog> - The list of catalogs.
- compartment
Id String - Compartment identifier.
- id String
- The provider-assigned unique ID for this managed resource.
- display
Name String - Data catalog identifier, which can be renamed.
- filters
List<Get
Catalogs Filter> - state String
- The current state of the data catalog resource.
- catalogs
Get
Catalogs Catalog[] - The list of catalogs.
- compartment
Id string - Compartment identifier.
- id string
- The provider-assigned unique ID for this managed resource.
- display
Name string - Data catalog identifier, which can be renamed.
- filters
Get
Catalogs Filter[] - state string
- The current state of the data catalog resource.
- catalogs
Sequence[datacatalog.
Get Catalogs Catalog] - 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[datacatalog.
Get Catalogs Filter] - state str
- The current state of the data catalog resource.
- catalogs List<Property Map>
- The list of catalogs.
- compartment
Id String - Compartment identifier.
- id String
- The provider-assigned unique ID for this managed resource.
- display
Name 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
- Attached
Catalog List<string>Private Endpoints - The list of private reverse connection endpoints attached to the catalog
- Compartment
Id string - The OCID of the compartment where you want to list resources.
- Dictionary<string, string>
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- 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.
- Lifecycle
Details 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<Get
Catalogs Catalog Lock> - Locks associated with this resource.
- Number
Of intObjects - 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 stringUrl - The REST front endpoint URL to the data catalog instance.
- Service
Console stringUrl - 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.
- 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"}
- Time
Created string - The time the data catalog was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time the data catalog was updated. An RFC3339 formatted datetime string.
- Attached
Catalog []stringPrivate Endpoints - The list of private reverse connection endpoints attached to the catalog
- Compartment
Id string - The OCID of the compartment where you want to list resources.
- map[string]string
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- 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.
- Lifecycle
Details 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
[]Get
Catalogs Catalog Lock - Locks associated with this resource.
- Number
Of intObjects - 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 stringUrl - The REST front endpoint URL to the data catalog instance.
- Service
Console stringUrl - 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.
- 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"}
- Time
Created string - The time the data catalog was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time the data catalog was updated. An RFC3339 formatted datetime string.
- attached
Catalog List<String>Private Endpoints - The list of private reverse connection endpoints attached to the catalog
- compartment
Id String - The OCID of the compartment where you want to list resources.
- Map<String,String>
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- 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.
- lifecycle
Details 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<Get
Catalogs Catalog Lock> - Locks associated with this resource.
- number
Of IntegerObjects - 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 StringUrl - The REST front endpoint URL to the data catalog instance.
- service
Console StringUrl - 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.
- 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"}
- time
Created String - The time the data catalog was created. An RFC3339 formatted datetime string.
- time
Updated String - The time the data catalog was updated. An RFC3339 formatted datetime string.
- attached
Catalog string[]Private Endpoints - The list of private reverse connection endpoints attached to the catalog
- compartment
Id string - The OCID of the compartment where you want to list resources.
- {[key: string]: string}
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- {[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.
- lifecycle
Details 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
Get
Catalogs Catalog Lock[] - Locks associated with this resource.
- number
Of numberObjects - 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 stringUrl - The REST front endpoint URL to the data catalog instance.
- service
Console stringUrl - 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.
- {[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"}
- time
Created string - The time the data catalog was created. An RFC3339 formatted datetime string.
- time
Updated string - The time the data catalog was updated. An RFC3339 formatted datetime string.
- attached_
catalog_ Sequence[str]private_ endpoints - 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.
- 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.
- 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[datacatalog.
Get Catalogs Catalog Lock] - Locks associated with this resource.
- number_
of_ intobjects - 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_ strurl - The REST front endpoint URL to the data catalog instance.
- service_
console_ strurl - 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.
- 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.
- attached
Catalog List<String>Private Endpoints - The list of private reverse connection endpoints attached to the catalog
- compartment
Id String - The OCID of the compartment where you want to list resources.
- Map<String>
- Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- 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.
- lifecycle
Details 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.
- number
Of NumberObjects - 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 StringUrl - The REST front endpoint URL to the data catalog instance.
- service
Console StringUrl - 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.
- 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"}
- time
Created String - The time the data catalog was created. An RFC3339 formatted datetime string.
- time
Updated 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.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created 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.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- Time
Created 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.
- String
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created 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.
- string
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created 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.
- 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.
- String
- The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
- time
Created String - The time the data catalog was created. An RFC3339 formatted datetime string.
- type String
- Type of the lock.
GetCatalogsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.