Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
oci.DataIntegration.getWorkspaceExportRequest
Explore with Pulumi AI
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/v2/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)
public static Output<GetWorkspaceExportRequestResult> getWorkspaceExportRequest(GetWorkspaceExportRequestArgs args, InvokeOptions options)
fn::invoke:
  function: oci:DataIntegration/getWorkspaceExportRequest:getWorkspaceExportRequest
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Export
Request stringKey  - The key of the object export object request
 - Workspace
Id string - The workspace ID.
 
- Export
Request stringKey  - The key of the object export object request
 - Workspace
Id string - The workspace ID.
 
- export
Request StringKey  - The key of the object export object request
 - workspace
Id String - The workspace ID.
 
- export
Request stringKey  - The key of the object export object request
 - workspace
Id string - The workspace ID.
 
- export_
request_ strkey  - The key of the object export object request
 - workspace_
id str - The workspace ID.
 
- export
Request StringKey  - The key of the object export object request
 - workspace
Id String - The workspace ID.
 
getWorkspaceExportRequest Result
The following output properties are available:
- Are
References boolIncluded  - 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
 - Created
By string - Name of the user who initiated export request.
 - Error
Messages Dictionary<string, string> - Contains key of the error
 - Export
Request stringKey  - Exported
Items List<GetWorkspace Export Request Exported Item>  - The array of exported object details.
 - File
Name string - Name of the exported zip file.
 - Filters List<string>
 - Export multiple objects based on filters.
 - Id string
 - Is
Object boolOverwrite Enabled  - 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.
 - Object
Keys List<string> - The list of the objects to be exported
 - Object
Storage stringRegion  - Region of the object storage (if using object storage of different region)
 - Object
Storage stringTenancy Id  - Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
 - Referenced
Items string - The array of exported referenced objects.
 - Status string
 - Export Objects request status.
 - Time
Ended stringIn Millis  - Time at which the request was completely processed.
 - Time
Started stringIn Millis  - Time at which the request started getting processed.
 - Total
Exported intObject Count  - Number of objects that are exported.
 - Workspace
Id string 
- Are
References boolIncluded  - 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
 - Created
By string - Name of the user who initiated export request.
 - Error
Messages map[string]string - Contains key of the error
 - Export
Request stringKey  - Exported
Items []GetWorkspace Export Request Exported Item  - The array of exported object details.
 - File
Name string - Name of the exported zip file.
 - Filters []string
 - Export multiple objects based on filters.
 - Id string
 - Is
Object boolOverwrite Enabled  - 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.
 - Object
Keys []string - The list of the objects to be exported
 - Object
Storage stringRegion  - Region of the object storage (if using object storage of different region)
 - Object
Storage stringTenancy Id  - Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
 - Referenced
Items string - The array of exported referenced objects.
 - Status string
 - Export Objects request status.
 - Time
Ended stringIn Millis  - Time at which the request was completely processed.
 - Time
Started stringIn Millis  - Time at which the request started getting processed.
 - Total
Exported intObject Count  - Number of objects that are exported.
 - Workspace
Id string 
- are
References BooleanIncluded  - 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
 - created
By String - Name of the user who initiated export request.
 - error
Messages Map<String,String> - Contains key of the error
 - export
Request StringKey  - exported
Items List<GetWorkspace Export Request Exported Item>  - The array of exported object details.
 - file
Name String - Name of the exported zip file.
 - filters List<String>
 - Export multiple objects based on filters.
 - id String
 - is
Object BooleanOverwrite Enabled  - 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.
 - object
Keys List<String> - The list of the objects to be exported
 - object
Storage StringRegion  - Region of the object storage (if using object storage of different region)
 - object
Storage StringTenancy Id  - Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
 - referenced
Items String - The array of exported referenced objects.
 - status String
 - Export Objects request status.
 - time
Ended StringIn Millis  - Time at which the request was completely processed.
 - time
Started StringIn Millis  - Time at which the request started getting processed.
 - total
Exported IntegerObject Count  - Number of objects that are exported.
 - workspace
Id String 
- are
References booleanIncluded  - 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
 - created
By string - Name of the user who initiated export request.
 - error
Messages {[key: string]: string} - Contains key of the error
 - export
Request stringKey  - exported
Items GetWorkspace Export Request Exported Item[]  - The array of exported object details.
 - file
Name string - Name of the exported zip file.
 - filters string[]
 - Export multiple objects based on filters.
 - id string
 - is
Object booleanOverwrite Enabled  - 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.
 - object
Keys string[] - The list of the objects to be exported
 - object
Storage stringRegion  - Region of the object storage (if using object storage of different region)
 - object
Storage stringTenancy Id  - Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
 - referenced
Items string - The array of exported referenced objects.
 - status string
 - Export Objects request status.
 - time
Ended stringIn Millis  - Time at which the request was completely processed.
 - time
Started stringIn Millis  - Time at which the request started getting processed.
 - total
Exported numberObject Count  - Number of objects that are exported.
 - workspace
Id string 
- are_
references_ boolincluded  - 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, str] - Contains key of the error
 - export_
request_ strkey  - exported_
items Sequence[dataintegration.Get Workspace Export Request Exported Item]  - 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_ booloverwrite_ enabled  - 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_ strregion  - Region of the object storage (if using object storage of different region)
 - object_
storage_ strtenancy_ id  - 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_ strin_ millis  - Time at which the request was completely processed.
 - time_
started_ strin_ millis  - Time at which the request started getting processed.
 - total_
exported_ intobject_ count  - Number of objects that are exported.
 - workspace_
id str 
- are
References BooleanIncluded  - 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
 - created
By String - Name of the user who initiated export request.
 - error
Messages Map<String> - Contains key of the error
 - export
Request StringKey  - exported
Items List<Property Map> - The array of exported object details.
 - file
Name String - Name of the exported zip file.
 - filters List<String>
 - Export multiple objects based on filters.
 - id String
 - is
Object BooleanOverwrite Enabled  - 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.
 - object
Keys List<String> - The list of the objects to be exported
 - object
Storage StringRegion  - Region of the object storage (if using object storage of different region)
 - object
Storage StringTenancy Id  - Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
 - referenced
Items String - The array of exported referenced objects.
 - status String
 - Export Objects request status.
 - time
Ended StringIn Millis  - Time at which the request was completely processed.
 - time
Started StringIn Millis  - Time at which the request started getting processed.
 - total
Exported NumberObject Count  - Number of objects that are exported.
 - workspace
Id String 
Supporting Types
GetWorkspaceExportRequestExportedItem     
- Aggregator
Key string - Aggregator key
 - Identifier string
 - Object identifier
 - Key string
 - Export object request key
 - Name string
 - Name of the export request.
 - Name
Path string - Object name path
 - Object
Type string - Object type
 - Object
Version string - Object version
 - Time
Updated stringIn Millis  - time at which this object was last updated.
 
- Aggregator
Key string - Aggregator key
 - Identifier string
 - Object identifier
 - Key string
 - Export object request key
 - Name string
 - Name of the export request.
 - Name
Path string - Object name path
 - Object
Type string - Object type
 - Object
Version string - Object version
 - Time
Updated stringIn Millis  - time at which this object was last updated.
 
- aggregator
Key String - Aggregator key
 - identifier String
 - Object identifier
 - key String
 - Export object request key
 - name String
 - Name of the export request.
 - name
Path String - Object name path
 - object
Type String - Object type
 - object
Version String - Object version
 - time
Updated StringIn Millis  - time at which this object was last updated.
 
- aggregator
Key string - Aggregator key
 - identifier string
 - Object identifier
 - key string
 - Export object request key
 - name string
 - Name of the export request.
 - name
Path string - Object name path
 - object
Type string - Object type
 - object
Version string - Object version
 - time
Updated stringIn Millis  - 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_ strin_ millis  - time at which this object was last updated.
 
- aggregator
Key String - Aggregator key
 - identifier String
 - Object identifier
 - key String
 - Export object request key
 - name String
 - Name of the export request.
 - name
Path String - Object name path
 - object
Type String - Object type
 - object
Version String - Object version
 - time
Updated StringIn Millis  - 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 
ociTerraform Provider.