Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataIntegration
  5. getWorkspaceExportRequest
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataIntegration.getWorkspaceExportRequest

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

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

    This endpoint can be used to get the summary/details of object being exported.

    Example Usage

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

const testWorkspaceExportRequest = oci.DataIntegration.getWorkspaceExportRequest({
    exportRequestKey: workspaceExportRequestExportRequestKey,
    workspaceId: testWorkspace.id,
});

    import pulumi
import pulumi_oci as oci

test_workspace_export_request = oci.DataIntegration.get_workspace_export_request(export_request_key=workspace_export_request_export_request_key,
    workspace_id=test_workspace["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataIntegration.GetWorkspaceExportRequest(ctx, &dataintegration.GetWorkspaceExportRequestArgs{
			ExportRequestKey: workspaceExportRequestExportRequestKey,
			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 testWorkspaceExportRequest = Oci.DataIntegration.GetWorkspaceExportRequest.Invoke(new()
    {
        ExportRequestKey = workspaceExportRequestExportRequestKey,
        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.GetWorkspaceExportRequestArgs;
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 testWorkspaceExportRequest = DataIntegrationFunctions.getWorkspaceExportRequest(GetWorkspaceExportRequestArgs.builder()
            .exportRequestKey(workspaceExportRequestExportRequestKey)
            .workspaceId(testWorkspace.id())
            .build());

    }
}

    variables:
  testWorkspaceExportRequest:
    fn::invoke:
      Function: oci:DataIntegration:getWorkspaceExportRequest
      Arguments:
        exportRequestKey: ${workspaceExportRequestExportRequestKey}
        workspaceId: ${testWorkspace.id}

    Using getWorkspaceExportRequest

    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 getWorkspaceExportRequest(args: GetWorkspaceExportRequestArgs, opts?: InvokeOptions): Promise<GetWorkspaceExportRequestResult>
function getWorkspaceExportRequestOutput(args: GetWorkspaceExportRequestOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceExportRequestResult>
    def get_workspace_export_request(export_request_key: Optional[str] = None,
                                 workspace_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetWorkspaceExportRequestResult
def get_workspace_export_request_output(export_request_key: Optional[pulumi.Input[str]] = None,
                                 workspace_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceExportRequestResult]
    func GetWorkspaceExportRequest(ctx *Context, args *GetWorkspaceExportRequestArgs, opts ...InvokeOption) (*GetWorkspaceExportRequestResult, error)
func GetWorkspaceExportRequestOutput(ctx *Context, args *GetWorkspaceExportRequestOutputArgs, opts ...InvokeOption) GetWorkspaceExportRequestResultOutput

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

    public static class GetWorkspaceExportRequest 
{
    public static Task<GetWorkspaceExportRequestResult> InvokeAsync(GetWorkspaceExportRequestArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceExportRequestResult> Invoke(GetWorkspaceExportRequestInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkspaceExportRequestResult> getWorkspaceExportRequest(GetWorkspaceExportRequestArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    ExportRequestKey string
    The key of the object export object request
    WorkspaceId string
    The workspace ID.
    ExportRequestKey string
    The key of the object export object request
    WorkspaceId string
    The workspace ID.
    exportRequestKey String
    The key of the object export object request
    workspaceId String
    The workspace ID.
    exportRequestKey string
    The key of the object export object request
    workspaceId string
    The workspace ID.
    export_request_key str
    The key of the object export object request
    workspace_id str
    The workspace ID.
    exportRequestKey String
    The key of the object export object request
    workspaceId String
    The workspace ID.

    getWorkspaceExportRequest Result

    The following output properties are available:

    AreReferencesIncluded bool
    Controls if the references will be exported along with the objects
    Bucket string
    The name of the Object Storage Bucket where the objects will be exported to
    CreatedBy string
    Name of the user who initiated export request.
    ErrorMessages Dictionary<string, object>
    Contains key of the error
    ExportRequestKey string
    ExportedItems List<GetWorkspaceExportRequestExportedItem>
    The array of exported object details.
    FileName string
    Name of the exported zip file.
    Filters List<string>
    Export multiple objects based on filters.
    Id string
    IsObjectOverwriteEnabled bool
    Flag to control whether to overwrite the object if it is already present at the provided object storage location.
    Key string
    Export object request key
    Name string
    Name of the export request.
    ObjectKeys List<string>
    The list of the objects to be exported
    ObjectStorageRegion string
    Region of the object storage (if using object storage of different region)
    ObjectStorageTenancyId string
    Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
    ReferencedItems string
    The array of exported referenced objects.
    Status string
    Export Objects request status.
    TimeEndedInMillis string
    Time at which the request was completely processed.
    TimeStartedInMillis string
    Time at which the request started getting processed.
    TotalExportedObjectCount int
    Number of objects that are exported.
    WorkspaceId string
    AreReferencesIncluded bool
    Controls if the references will be exported along with the objects
    Bucket string
    The name of the Object Storage Bucket where the objects will be exported to
    CreatedBy string
    Name of the user who initiated export request.
    ErrorMessages map[string]interface{}
    Contains key of the error
    ExportRequestKey string
    ExportedItems []GetWorkspaceExportRequestExportedItem
    The array of exported object details.
    FileName string
    Name of the exported zip file.
    Filters []string
    Export multiple objects based on filters.
    Id string
    IsObjectOverwriteEnabled bool
    Flag to control whether to overwrite the object if it is already present at the provided object storage location.
    Key string
    Export object request key
    Name string
    Name of the export request.
    ObjectKeys []string
    The list of the objects to be exported
    ObjectStorageRegion string
    Region of the object storage (if using object storage of different region)
    ObjectStorageTenancyId string
    Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
    ReferencedItems string
    The array of exported referenced objects.
    Status string
    Export Objects request status.
    TimeEndedInMillis string
    Time at which the request was completely processed.
    TimeStartedInMillis string
    Time at which the request started getting processed.
    TotalExportedObjectCount int
    Number of objects that are exported.
    WorkspaceId string
    areReferencesIncluded Boolean
    Controls if the references will be exported along with the objects
    bucket String
    The name of the Object Storage Bucket where the objects will be exported to
    createdBy String
    Name of the user who initiated export request.
    errorMessages Map<String,Object>
    Contains key of the error
    exportRequestKey String
    exportedItems List<GetWorkspaceExportRequestExportedItem>
    The array of exported object details.
    fileName String
    Name of the exported zip file.
    filters List<String>
    Export multiple objects based on filters.
    id String
    isObjectOverwriteEnabled Boolean
    Flag to control whether to overwrite the object if it is already present at the provided object storage location.
    key String
    Export object request key
    name String
    Name of the export request.
    objectKeys List<String>
    The list of the objects to be exported
    objectStorageRegion String
    Region of the object storage (if using object storage of different region)
    objectStorageTenancyId String
    Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
    referencedItems String
    The array of exported referenced objects.
    status String
    Export Objects request status.
    timeEndedInMillis String
    Time at which the request was completely processed.
    timeStartedInMillis String
    Time at which the request started getting processed.
    totalExportedObjectCount Integer
    Number of objects that are exported.
    workspaceId String
    areReferencesIncluded boolean
    Controls if the references will be exported along with the objects
    bucket string
    The name of the Object Storage Bucket where the objects will be exported to
    createdBy string
    Name of the user who initiated export request.
    errorMessages {[key: string]: any}
    Contains key of the error
    exportRequestKey string
    exportedItems GetWorkspaceExportRequestExportedItem[]
    The array of exported object details.
    fileName string
    Name of the exported zip file.
    filters string[]
    Export multiple objects based on filters.
    id string
    isObjectOverwriteEnabled boolean
    Flag to control whether to overwrite the object if it is already present at the provided object storage location.
    key string
    Export object request key
    name string
    Name of the export request.
    objectKeys string[]
    The list of the objects to be exported
    objectStorageRegion string
    Region of the object storage (if using object storage of different region)
    objectStorageTenancyId string
    Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
    referencedItems string
    The array of exported referenced objects.
    status string
    Export Objects request status.
    timeEndedInMillis string
    Time at which the request was completely processed.
    timeStartedInMillis string
    Time at which the request started getting processed.
    totalExportedObjectCount number
    Number of objects that are exported.
    workspaceId string
    are_references_included bool
    Controls if the references will be exported along with the objects
    bucket str
    The name of the Object Storage Bucket where the objects will be exported to
    created_by str
    Name of the user who initiated export request.
    error_messages Mapping[str, Any]
    Contains key of the error
    export_request_key str
    exported_items Sequence[dataintegration.GetWorkspaceExportRequestExportedItem]
    The array of exported object details.
    file_name str
    Name of the exported zip file.
    filters Sequence[str]
    Export multiple objects based on filters.
    id str
    is_object_overwrite_enabled bool
    Flag to control whether to overwrite the object if it is already present at the provided object storage location.
    key str
    Export object request key
    name str
    Name of the export request.
    object_keys Sequence[str]
    The list of the objects to be exported
    object_storage_region str
    Region of the object storage (if using object storage of different region)
    object_storage_tenancy_id str
    Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
    referenced_items str
    The array of exported referenced objects.
    status str
    Export Objects request status.
    time_ended_in_millis str
    Time at which the request was completely processed.
    time_started_in_millis str
    Time at which the request started getting processed.
    total_exported_object_count int
    Number of objects that are exported.
    workspace_id str
    areReferencesIncluded Boolean
    Controls if the references will be exported along with the objects
    bucket String
    The name of the Object Storage Bucket where the objects will be exported to
    createdBy String
    Name of the user who initiated export request.
    errorMessages Map<Any>
    Contains key of the error
    exportRequestKey String
    exportedItems List<Property Map>
    The array of exported object details.
    fileName String
    Name of the exported zip file.
    filters List<String>
    Export multiple objects based on filters.
    id String
    isObjectOverwriteEnabled Boolean
    Flag to control whether to overwrite the object if it is already present at the provided object storage location.
    key String
    Export object request key
    name String
    Name of the export request.
    objectKeys List<String>
    The list of the objects to be exported
    objectStorageRegion String
    Region of the object storage (if using object storage of different region)
    objectStorageTenancyId String
    Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
    referencedItems String
    The array of exported referenced objects.
    status String
    Export Objects request status.
    timeEndedInMillis String
    Time at which the request was completely processed.
    timeStartedInMillis String
    Time at which the request started getting processed.
    totalExportedObjectCount Number
    Number of objects that are exported.
    workspaceId String

    Supporting Types

    GetWorkspaceExportRequestExportedItem

    AggregatorKey string
    Aggregator key
    Identifier string
    Object identifier
    Key string
    Export object request key
    Name string
    Name of the export request.
    NamePath string
    Object name path
    ObjectType string
    Object type
    ObjectVersion string
    Object version
    TimeUpdatedInMillis string
    time at which this object was last updated.
    AggregatorKey string
    Aggregator key
    Identifier string
    Object identifier
    Key string
    Export object request key
    Name string
    Name of the export request.
    NamePath string
    Object name path
    ObjectType string
    Object type
    ObjectVersion string
    Object version
    TimeUpdatedInMillis string
    time at which this object was last updated.
    aggregatorKey String
    Aggregator key
    identifier String
    Object identifier
    key String
    Export object request key
    name String
    Name of the export request.
    namePath String
    Object name path
    objectType String
    Object type
    objectVersion String
    Object version
    timeUpdatedInMillis String
    time at which this object was last updated.
    aggregatorKey string
    Aggregator key
    identifier string
    Object identifier
    key string
    Export object request key
    name string
    Name of the export request.
    namePath string
    Object name path
    objectType string
    Object type
    objectVersion string
    Object version
    timeUpdatedInMillis string
    time at which this object was last updated.
    aggregator_key str
    Aggregator key
    identifier str
    Object identifier
    key str
    Export object request key
    name str
    Name of the export request.
    name_path str
    Object name path
    object_type str
    Object type
    object_version str
    Object version
    time_updated_in_millis str
    time at which this object was last updated.
    aggregatorKey String
    Aggregator key
    identifier String
    Object identifier
    key String
    Export object request key
    name String
    Name of the export request.
    namePath String
    Object name path
    objectType String
    Object type
    objectVersion String
    Object version
    timeUpdatedInMillis String
    time at which this object was last updated.

    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 v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci