getWorkspaceExportRequest.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package dataintegration

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi-oci/sdk/go/oci/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// 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
//
// ```go
// 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
//		})
//	}
//
// ```
func LookupWorkspaceExportRequest(ctx *pulumi.Context, args *LookupWorkspaceExportRequestArgs, opts ...pulumi.InvokeOption) (*LookupWorkspaceExportRequestResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv LookupWorkspaceExportRequestResult
	err := ctx.Invoke("oci:DataIntegration/getWorkspaceExportRequest:getWorkspaceExportRequest", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getWorkspaceExportRequest.
type LookupWorkspaceExportRequestArgs struct {
	// The key of the object export object request
	ExportRequestKey string `pulumi:"exportRequestKey"`
	// The workspace ID.
	WorkspaceId string `pulumi:"workspaceId"`
}

// A collection of values returned by getWorkspaceExportRequest.
type LookupWorkspaceExportRequestResult struct {
	// Controls if the references will be exported along with the objects
	AreReferencesIncluded bool `pulumi:"areReferencesIncluded"`
	// The name of the Object Storage Bucket where the objects will be exported to
	Bucket string `pulumi:"bucket"`
	// Name of the user who initiated export request.
	CreatedBy string `pulumi:"createdBy"`
	// Contains key of the error
	ErrorMessages    map[string]interface{} `pulumi:"errorMessages"`
	ExportRequestKey string                 `pulumi:"exportRequestKey"`
	// The array of exported object details.
	ExportedItems []GetWorkspaceExportRequestExportedItem `pulumi:"exportedItems"`
	// Name of the exported zip file.
	FileName string `pulumi:"fileName"`
	// Export multiple objects based on filters.
	Filters []string `pulumi:"filters"`
	Id      string   `pulumi:"id"`
	// Flag to control whether to overwrite the object if it is already present at the provided object storage location.
	IsObjectOverwriteEnabled bool `pulumi:"isObjectOverwriteEnabled"`
	// Export object request key
	Key string `pulumi:"key"`
	// Name of the export request.
	Name string `pulumi:"name"`
	// The list of the objects to be exported
	ObjectKeys []string `pulumi:"objectKeys"`
	// Region of the object storage (if using object storage of different region)
	ObjectStorageRegion string `pulumi:"objectStorageRegion"`
	// Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
	ObjectStorageTenancyId string `pulumi:"objectStorageTenancyId"`
	// The array of exported referenced objects.
	ReferencedItems string `pulumi:"referencedItems"`
	// Export Objects request status.
	Status string `pulumi:"status"`
	// Time at which the request was completely processed.
	TimeEndedInMillis string `pulumi:"timeEndedInMillis"`
	// Time at which the request started getting processed.
	TimeStartedInMillis string `pulumi:"timeStartedInMillis"`
	// Number of objects that are exported.
	TotalExportedObjectCount int    `pulumi:"totalExportedObjectCount"`
	WorkspaceId              string `pulumi:"workspaceId"`
}

func LookupWorkspaceExportRequestOutput(ctx *pulumi.Context, args LookupWorkspaceExportRequestOutputArgs, opts ...pulumi.InvokeOption) LookupWorkspaceExportRequestResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (LookupWorkspaceExportRequestResult, error) {
			args := v.(LookupWorkspaceExportRequestArgs)
			r, err := LookupWorkspaceExportRequest(ctx, &args, opts...)
			var s LookupWorkspaceExportRequestResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(LookupWorkspaceExportRequestResultOutput)
}

// A collection of arguments for invoking getWorkspaceExportRequest.
type LookupWorkspaceExportRequestOutputArgs struct {
	// The key of the object export object request
	ExportRequestKey pulumi.StringInput `pulumi:"exportRequestKey"`
	// The workspace ID.
	WorkspaceId pulumi.StringInput `pulumi:"workspaceId"`
}

func (LookupWorkspaceExportRequestOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupWorkspaceExportRequestArgs)(nil)).Elem()
}

// A collection of values returned by getWorkspaceExportRequest.
type LookupWorkspaceExportRequestResultOutput struct{ *pulumi.OutputState }

func (LookupWorkspaceExportRequestResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupWorkspaceExportRequestResult)(nil)).Elem()
}

func (o LookupWorkspaceExportRequestResultOutput) ToLookupWorkspaceExportRequestResultOutput() LookupWorkspaceExportRequestResultOutput {
	return o
}

func (o LookupWorkspaceExportRequestResultOutput) ToLookupWorkspaceExportRequestResultOutputWithContext(ctx context.Context) LookupWorkspaceExportRequestResultOutput {
	return o
}

// Controls if the references will be exported along with the objects
func (o LookupWorkspaceExportRequestResultOutput) AreReferencesIncluded() pulumi.BoolOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) bool { return v.AreReferencesIncluded }).(pulumi.BoolOutput)
}

// The name of the Object Storage Bucket where the objects will be exported to
func (o LookupWorkspaceExportRequestResultOutput) Bucket() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.Bucket }).(pulumi.StringOutput)
}

// Name of the user who initiated export request.
func (o LookupWorkspaceExportRequestResultOutput) CreatedBy() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.CreatedBy }).(pulumi.StringOutput)
}

// Contains key of the error
func (o LookupWorkspaceExportRequestResultOutput) ErrorMessages() pulumi.MapOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) map[string]interface{} { return v.ErrorMessages }).(pulumi.MapOutput)
}

func (o LookupWorkspaceExportRequestResultOutput) ExportRequestKey() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.ExportRequestKey }).(pulumi.StringOutput)
}

// The array of exported object details.
func (o LookupWorkspaceExportRequestResultOutput) ExportedItems() GetWorkspaceExportRequestExportedItemArrayOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) []GetWorkspaceExportRequestExportedItem {
		return v.ExportedItems
	}).(GetWorkspaceExportRequestExportedItemArrayOutput)
}

// Name of the exported zip file.
func (o LookupWorkspaceExportRequestResultOutput) FileName() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.FileName }).(pulumi.StringOutput)
}

// Export multiple objects based on filters.
func (o LookupWorkspaceExportRequestResultOutput) Filters() pulumi.StringArrayOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) []string { return v.Filters }).(pulumi.StringArrayOutput)
}

func (o LookupWorkspaceExportRequestResultOutput) Id() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.Id }).(pulumi.StringOutput)
}

// Flag to control whether to overwrite the object if it is already present at the provided object storage location.
func (o LookupWorkspaceExportRequestResultOutput) IsObjectOverwriteEnabled() pulumi.BoolOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) bool { return v.IsObjectOverwriteEnabled }).(pulumi.BoolOutput)
}

// Export object request key
func (o LookupWorkspaceExportRequestResultOutput) Key() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.Key }).(pulumi.StringOutput)
}

// Name of the export request.
func (o LookupWorkspaceExportRequestResultOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.Name }).(pulumi.StringOutput)
}

// The list of the objects to be exported
func (o LookupWorkspaceExportRequestResultOutput) ObjectKeys() pulumi.StringArrayOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) []string { return v.ObjectKeys }).(pulumi.StringArrayOutput)
}

// Region of the object storage (if using object storage of different region)
func (o LookupWorkspaceExportRequestResultOutput) ObjectStorageRegion() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.ObjectStorageRegion }).(pulumi.StringOutput)
}

// Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
func (o LookupWorkspaceExportRequestResultOutput) ObjectStorageTenancyId() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.ObjectStorageTenancyId }).(pulumi.StringOutput)
}

// The array of exported referenced objects.
func (o LookupWorkspaceExportRequestResultOutput) ReferencedItems() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.ReferencedItems }).(pulumi.StringOutput)
}

// Export Objects request status.
func (o LookupWorkspaceExportRequestResultOutput) Status() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.Status }).(pulumi.StringOutput)
}

// Time at which the request was completely processed.
func (o LookupWorkspaceExportRequestResultOutput) TimeEndedInMillis() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.TimeEndedInMillis }).(pulumi.StringOutput)
}

// Time at which the request started getting processed.
func (o LookupWorkspaceExportRequestResultOutput) TimeStartedInMillis() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.TimeStartedInMillis }).(pulumi.StringOutput)
}

// Number of objects that are exported.
func (o LookupWorkspaceExportRequestResultOutput) TotalExportedObjectCount() pulumi.IntOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) int { return v.TotalExportedObjectCount }).(pulumi.IntOutput)
}

func (o LookupWorkspaceExportRequestResultOutput) WorkspaceId() pulumi.StringOutput {
	return o.ApplyT(func(v LookupWorkspaceExportRequestResult) string { return v.WorkspaceId }).(pulumi.StringOutput)
}

func init() {
	pulumi.RegisterOutputType(LookupWorkspaceExportRequestResultOutput{})
}