Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataIntegration
  5. getWorkspaceFolder
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.DataIntegration.getWorkspaceFolder

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Workspace Folder resource in Oracle Cloud Infrastructure Data Integration service.

    Retrieves a folder using the specified identifier.

    Example Usage

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

const testWorkspaceFolder = oci.DataIntegration.getWorkspaceFolder({
    folderKey: workspaceFolderFolderKey,
    workspaceId: testWorkspace.id,
});

    import pulumi
import pulumi_oci as oci

test_workspace_folder = oci.DataIntegration.get_workspace_folder(folder_key=workspace_folder_folder_key,
    workspace_id=test_workspace["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/dataintegration"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataintegration.GetWorkspaceFolder(ctx, &dataintegration.GetWorkspaceFolderArgs{
			FolderKey:   workspaceFolderFolderKey,
			WorkspaceId: testWorkspace.Id,
		}, 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 testWorkspaceFolder = Oci.DataIntegration.GetWorkspaceFolder.Invoke(new()
    {
        FolderKey = workspaceFolderFolderKey,
        WorkspaceId = testWorkspace.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataIntegration.DataIntegrationFunctions;
import com.pulumi.oci.DataIntegration.inputs.GetWorkspaceFolderArgs;
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 testWorkspaceFolder = DataIntegrationFunctions.getWorkspaceFolder(GetWorkspaceFolderArgs.builder()
            .folderKey(workspaceFolderFolderKey)
            .workspaceId(testWorkspace.id())
            .build());

    }
}

    variables:
  testWorkspaceFolder:
    fn::invoke:
      function: oci:DataIntegration:getWorkspaceFolder
      arguments:
        folderKey: ${workspaceFolderFolderKey}
        workspaceId: ${testWorkspace.id}

    Using getWorkspaceFolder

    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 getWorkspaceFolder(args: GetWorkspaceFolderArgs, opts?: InvokeOptions): Promise<GetWorkspaceFolderResult>
function getWorkspaceFolderOutput(args: GetWorkspaceFolderOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceFolderResult>
    def get_workspace_folder(folder_key: Optional[str] = None,
                         workspace_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetWorkspaceFolderResult
def get_workspace_folder_output(folder_key: Optional[pulumi.Input[str]] = None,
                         workspace_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceFolderResult]
    func GetWorkspaceFolder(ctx *Context, args *GetWorkspaceFolderArgs, opts ...InvokeOption) (*GetWorkspaceFolderResult, error)
func GetWorkspaceFolderOutput(ctx *Context, args *GetWorkspaceFolderOutputArgs, opts ...InvokeOption) GetWorkspaceFolderResultOutput

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

    public static class GetWorkspaceFolder 
{
    public static Task<GetWorkspaceFolderResult> InvokeAsync(GetWorkspaceFolderArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceFolderResult> Invoke(GetWorkspaceFolderInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkspaceFolderResult> getWorkspaceFolder(GetWorkspaceFolderArgs args, InvokeOptions options)
public static Output<GetWorkspaceFolderResult> getWorkspaceFolder(GetWorkspaceFolderArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:DataIntegration/getWorkspaceFolder:getWorkspaceFolder
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FolderKey string
    The folder key.
    WorkspaceId string
    The workspace ID.
    FolderKey string
    The folder key.
    WorkspaceId string
    The workspace ID.
    folderKey String
    The folder key.
    workspaceId String
    The workspace ID.
    folderKey string
    The folder key.
    workspaceId string
    The workspace ID.
    folder_key str
    The folder key.
    workspace_id str
    The workspace ID.
    folderKey String
    The folder key.
    workspaceId String
    The workspace ID.

    getWorkspaceFolder Result

    The following output properties are available:

    CategoryName string
    The category name.
    Description string
    The description of the aggregator.
    FolderKey string
    Id string
    Identifier string
    The identifier of the aggregator.
    Key string
    The key of the aggregator object.
    KeyMap Dictionary<string, string>
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    Metadatas List<GetWorkspaceFolderMetadata>
    A summary type containing information about the object including its key, name and when/who created/updated it.
    ModelType string
    The type of the object.
    ModelVersion string
    The model version of an object.
    Name string
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    ObjectStatus int
    The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    ObjectVersion int
    The version of the object that is used to track changes in the object instance.
    ParentReves List<GetWorkspaceFolderParentRef>
    A reference to the object's parent.
    RegistryMetadatas List<GetWorkspaceFolderRegistryMetadata>
    WorkspaceId string
    CategoryName string
    The category name.
    Description string
    The description of the aggregator.
    FolderKey string
    Id string
    Identifier string
    The identifier of the aggregator.
    Key string
    The key of the aggregator object.
    KeyMap map[string]string
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    Metadatas []GetWorkspaceFolderMetadata
    A summary type containing information about the object including its key, name and when/who created/updated it.
    ModelType string
    The type of the object.
    ModelVersion string
    The model version of an object.
    Name string
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    ObjectStatus int
    The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    ObjectVersion int
    The version of the object that is used to track changes in the object instance.
    ParentReves []GetWorkspaceFolderParentRef
    A reference to the object's parent.
    RegistryMetadatas []GetWorkspaceFolderRegistryMetadata
    WorkspaceId string
    categoryName String
    The category name.
    description String
    The description of the aggregator.
    folderKey String
    id String
    identifier String
    The identifier of the aggregator.
    key String
    The key of the aggregator object.
    keyMap Map<String,String>
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas List<GetWorkspaceFolderMetadata>
    A summary type containing information about the object including its key, name and when/who created/updated it.
    modelType String
    The type of the object.
    modelVersion String
    The model version of an object.
    name String
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    objectStatus Integer
    The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    objectVersion Integer
    The version of the object that is used to track changes in the object instance.
    parentReves List<GetWorkspaceFolderParentRef>
    A reference to the object's parent.
    registryMetadatas List<GetWorkspaceFolderRegistryMetadata>
    workspaceId String
    categoryName string
    The category name.
    description string
    The description of the aggregator.
    folderKey string
    id string
    identifier string
    The identifier of the aggregator.
    key string
    The key of the aggregator object.
    keyMap {[key: string]: string}
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas GetWorkspaceFolderMetadata[]
    A summary type containing information about the object including its key, name and when/who created/updated it.
    modelType string
    The type of the object.
    modelVersion string
    The model version of an object.
    name string
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    objectStatus number
    The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    objectVersion number
    The version of the object that is used to track changes in the object instance.
    parentReves GetWorkspaceFolderParentRef[]
    A reference to the object's parent.
    registryMetadatas GetWorkspaceFolderRegistryMetadata[]
    workspaceId string
    category_name str
    The category name.
    description str
    The description of the aggregator.
    folder_key str
    id str
    identifier str
    The identifier of the aggregator.
    key str
    The key of the aggregator object.
    key_map Mapping[str, str]
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas Sequence[dataintegration.GetWorkspaceFolderMetadata]
    A summary type containing information about the object including its key, name and when/who created/updated it.
    model_type str
    The type of the object.
    model_version str
    The model version of an object.
    name str
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    object_status int
    The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    object_version int
    The version of the object that is used to track changes in the object instance.
    parent_reves Sequence[dataintegration.GetWorkspaceFolderParentRef]
    A reference to the object's parent.
    registry_metadatas Sequence[dataintegration.GetWorkspaceFolderRegistryMetadata]
    workspace_id str
    categoryName String
    The category name.
    description String
    The description of the aggregator.
    folderKey String
    id String
    identifier String
    The identifier of the aggregator.
    key String
    The key of the aggregator object.
    keyMap Map<String>
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas List<Property Map>
    A summary type containing information about the object including its key, name and when/who created/updated it.
    modelType String
    The type of the object.
    modelVersion String
    The model version of an object.
    name String
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    objectStatus Number
    The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    objectVersion Number
    The version of the object that is used to track changes in the object instance.
    parentReves List<Property Map>
    A reference to the object's parent.
    registryMetadatas List<Property Map>
    workspaceId String

    Supporting Types

    GetWorkspaceFolderMetadata

    AggregatorKey string
    The owning object key for this object.
    Aggregators List<GetWorkspaceFolderMetadataAggregator>
    A summary type containing information about the object's aggregator including its type, key, name and description.
    CountStatistics List<GetWorkspaceFolderMetadataCountStatistic>
    A count statistics.
    CreatedBy string
    The user that created the object.
    CreatedByName string
    The user that created the object.
    IdentifierPath string
    The full path to identify this object.
    InfoFields Dictionary<string, string>
    Information property fields.
    IsFavorite bool
    Specifies whether this object is a favorite or not.
    Labels List<string>
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    RegistryVersion int
    The registry version of the object.
    TimeCreated string
    The date and time that the object was created.
    TimeUpdated string
    The date and time that the object was updated.
    UpdatedBy string
    The user that updated the object.
    UpdatedByName string
    The user that updated the object.
    AggregatorKey string
    The owning object key for this object.
    Aggregators []GetWorkspaceFolderMetadataAggregator
    A summary type containing information about the object's aggregator including its type, key, name and description.
    CountStatistics []GetWorkspaceFolderMetadataCountStatistic
    A count statistics.
    CreatedBy string
    The user that created the object.
    CreatedByName string
    The user that created the object.
    IdentifierPath string
    The full path to identify this object.
    InfoFields map[string]string
    Information property fields.
    IsFavorite bool
    Specifies whether this object is a favorite or not.
    Labels []string
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    RegistryVersion int
    The registry version of the object.
    TimeCreated string
    The date and time that the object was created.
    TimeUpdated string
    The date and time that the object was updated.
    UpdatedBy string
    The user that updated the object.
    UpdatedByName string
    The user that updated the object.
    aggregatorKey String
    The owning object key for this object.
    aggregators List<GetWorkspaceFolderMetadataAggregator>
    A summary type containing information about the object's aggregator including its type, key, name and description.
    countStatistics List<GetWorkspaceFolderMetadataCountStatistic>
    A count statistics.
    createdBy String
    The user that created the object.
    createdByName String
    The user that created the object.
    identifierPath String
    The full path to identify this object.
    infoFields Map<String,String>
    Information property fields.
    isFavorite Boolean
    Specifies whether this object is a favorite or not.
    labels List<String>
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registryVersion Integer
    The registry version of the object.
    timeCreated String
    The date and time that the object was created.
    timeUpdated String
    The date and time that the object was updated.
    updatedBy String
    The user that updated the object.
    updatedByName String
    The user that updated the object.
    aggregatorKey string
    The owning object key for this object.
    aggregators GetWorkspaceFolderMetadataAggregator[]
    A summary type containing information about the object's aggregator including its type, key, name and description.
    countStatistics GetWorkspaceFolderMetadataCountStatistic[]
    A count statistics.
    createdBy string
    The user that created the object.
    createdByName string
    The user that created the object.
    identifierPath string
    The full path to identify this object.
    infoFields {[key: string]: string}
    Information property fields.
    isFavorite boolean
    Specifies whether this object is a favorite or not.
    labels string[]
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registryVersion number
    The registry version of the object.
    timeCreated string
    The date and time that the object was created.
    timeUpdated string
    The date and time that the object was updated.
    updatedBy string
    The user that updated the object.
    updatedByName string
    The user that updated the object.
    aggregator_key str
    The owning object key for this object.
    aggregators Sequence[dataintegration.GetWorkspaceFolderMetadataAggregator]
    A summary type containing information about the object's aggregator including its type, key, name and description.
    count_statistics Sequence[dataintegration.GetWorkspaceFolderMetadataCountStatistic]
    A count statistics.
    created_by str
    The user that created the object.
    created_by_name str
    The user that created the object.
    identifier_path str
    The full path to identify this object.
    info_fields Mapping[str, str]
    Information property fields.
    is_favorite bool
    Specifies whether this object is a favorite or not.
    labels Sequence[str]
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registry_version int
    The registry version of the object.
    time_created str
    The date and time that the object was created.
    time_updated str
    The date and time that the object was updated.
    updated_by str
    The user that updated the object.
    updated_by_name str
    The user that updated the object.
    aggregatorKey String
    The owning object key for this object.
    aggregators List<Property Map>
    A summary type containing information about the object's aggregator including its type, key, name and description.
    countStatistics List<Property Map>
    A count statistics.
    createdBy String
    The user that created the object.
    createdByName String
    The user that created the object.
    identifierPath String
    The full path to identify this object.
    infoFields Map<String>
    Information property fields.
    isFavorite Boolean
    Specifies whether this object is a favorite or not.
    labels List<String>
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registryVersion Number
    The registry version of the object.
    timeCreated String
    The date and time that the object was created.
    timeUpdated String
    The date and time that the object was updated.
    updatedBy String
    The user that updated the object.
    updatedByName String
    The user that updated the object.

    GetWorkspaceFolderMetadataAggregator

    Description string
    The description of the aggregator.
    Identifier string
    The identifier of the aggregator.
    Key string
    The key of the aggregator object.
    Name string
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    Type string
    The type of the aggregator.
    Description string
    The description of the aggregator.
    Identifier string
    The identifier of the aggregator.
    Key string
    The key of the aggregator object.
    Name string
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    Type string
    The type of the aggregator.
    description String
    The description of the aggregator.
    identifier String
    The identifier of the aggregator.
    key String
    The key of the aggregator object.
    name String
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    type String
    The type of the aggregator.
    description string
    The description of the aggregator.
    identifier string
    The identifier of the aggregator.
    key string
    The key of the aggregator object.
    name string
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    type string
    The type of the aggregator.
    description str
    The description of the aggregator.
    identifier str
    The identifier of the aggregator.
    key str
    The key of the aggregator object.
    name str
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    type str
    The type of the aggregator.
    description String
    The description of the aggregator.
    identifier String
    The identifier of the aggregator.
    key String
    The key of the aggregator object.
    name String
    Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    type String
    The type of the aggregator.

    GetWorkspaceFolderMetadataCountStatistic

    GetWorkspaceFolderMetadataCountStatisticObjectTypeCountList

    ObjectCount string
    The value for the count statistic object.
    ObjectType string
    The type of object for the count statistic object.
    ObjectCount string
    The value for the count statistic object.
    ObjectType string
    The type of object for the count statistic object.
    objectCount String
    The value for the count statistic object.
    objectType String
    The type of object for the count statistic object.
    objectCount string
    The value for the count statistic object.
    objectType string
    The type of object for the count statistic object.
    object_count str
    The value for the count statistic object.
    object_type str
    The type of object for the count statistic object.
    objectCount String
    The value for the count statistic object.
    objectType String
    The type of object for the count statistic object.

    GetWorkspaceFolderParentRef

    Parent string
    Key of the parent object.
    RootDocId string
    Key of the root document object.
    Parent string
    Key of the parent object.
    RootDocId string
    Key of the root document object.
    parent String
    Key of the parent object.
    rootDocId String
    Key of the root document object.
    parent string
    Key of the parent object.
    rootDocId string
    Key of the root document object.
    parent str
    Key of the parent object.
    root_doc_id str
    Key of the root document object.
    parent String
    Key of the parent object.
    rootDocId String
    Key of the root document object.

    GetWorkspaceFolderRegistryMetadata

    AggregatorKey string
    The owning object key for this object.
    IsFavorite bool
    Specifies whether this object is a favorite or not.
    Key string
    The key of the aggregator object.
    Labels List<string>
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    RegistryVersion int
    The registry version of the object.
    AggregatorKey string
    The owning object key for this object.
    IsFavorite bool
    Specifies whether this object is a favorite or not.
    Key string
    The key of the aggregator object.
    Labels []string
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    RegistryVersion int
    The registry version of the object.
    aggregatorKey String
    The owning object key for this object.
    isFavorite Boolean
    Specifies whether this object is a favorite or not.
    key String
    The key of the aggregator object.
    labels List<String>
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registryVersion Integer
    The registry version of the object.
    aggregatorKey string
    The owning object key for this object.
    isFavorite boolean
    Specifies whether this object is a favorite or not.
    key string
    The key of the aggregator object.
    labels string[]
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registryVersion number
    The registry version of the object.
    aggregator_key str
    The owning object key for this object.
    is_favorite bool
    Specifies whether this object is a favorite or not.
    key str
    The key of the aggregator object.
    labels Sequence[str]
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registry_version int
    The registry version of the object.
    aggregatorKey String
    The owning object key for this object.
    isFavorite Boolean
    Specifies whether this object is a favorite or not.
    key String
    The key of the aggregator object.
    labels List<String>
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registryVersion Number
    The registry version of the object.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
    pulumi/pulumi-oci