Package com.oracle.bmc.dataintegration.model

Class ExportRequest

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.dataintegration.model.ExportRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200430")
public final class ExportRequest
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Export metadata object response.
Note: Objects should always be created or deserialized using the ExportRequest.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ExportRequest.Builder, which maintain a set of all explicitly set fields called ExportRequest.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExportRequest.Builder
static class	ExportRequest.Status	Export Objects request status.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

ExportRequest(String key, List<String> objectKeys, String bucketName, String fileName, String objectStorageTenancyId, String objectStorageRegion, Boolean areReferencesIncluded, Boolean isObjectOverwriteEnabled, List<String> filters, ExportRequest.Status status, String createdBy, Integer totalExportedObjectCount, Long timeStartedInMillis, Long timeEndedInMillis, Map<String,String> errorMessages, List<ExportObjectMetadataSummary> exportedItems, String referencedItems, String name)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static ExportRequest.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getAreReferencesIncluded()	Controls if the references will be exported along with the objects
String	getBucketName()	The name of the Object Storage Bucket where the objects will be exported to
String	getCreatedBy()	Name of the user who initiated export request.
Map<String,String>	getErrorMessages()	Contains key of the error
List<ExportObjectMetadataSummary>	getExportedItems()	The array of exported object details.
String	getFileName()	Name of the exported zip file.
List<String>	getFilters()	Export multiple objects based on filters.
Boolean	getIsObjectOverwriteEnabled()	Flag to control whether to overwrite the object if it is already present at the provided object storage location.
String	getKey()	Export object request key
String	getName()	Name of the export request.
List<String>	getObjectKeys()	The list of the objects to be exported
String	getObjectStorageRegion()	Region of the object storage (if using object storage of different region)
String	getObjectStorageTenancyId()	Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)
String	getReferencedItems()	The array of exported referenced objects.
ExportRequest.Status	getStatus()	Export Objects request status.
Long	getTimeEndedInMillis()	Time at which the request was completely processed.
Long	getTimeStartedInMillis()	Time at which the request started getting processed.
Integer	getTotalExportedObjectCount()	Number of objects that are exported.
int	hashCode()
ExportRequest.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExportRequest

@Deprecated
@ConstructorProperties({"key","objectKeys","bucketName","fileName","objectStorageTenancyId","objectStorageRegion","areReferencesIncluded","isObjectOverwriteEnabled","filters","status","createdBy","totalExportedObjectCount","timeStartedInMillis","timeEndedInMillis","errorMessages","exportedItems","referencedItems","name"})
public ExportRequest(String key,
                     List<String> objectKeys,
                     String bucketName,
                     String fileName,
                     String objectStorageTenancyId,
                     String objectStorageRegion,
                     Boolean areReferencesIncluded,
                     Boolean isObjectOverwriteEnabled,
                     List<String> filters,
                     ExportRequest.Status status,
                     String createdBy,
                     Integer totalExportedObjectCount,
                     Long timeStartedInMillis,
                     Long timeEndedInMillis,
                     Map<String,String> errorMessages,
                     List<ExportObjectMetadataSummary> exportedItems,
                     String referencedItems,
                     String name)

Deprecated.

Method Detail

builder

public static ExportRequest.Builder builder()

Create a new builder.

toBuilder

public ExportRequest.Builder toBuilder()

getKey

public String getKey()

Export object request key

Returns:

the value

getObjectKeys

public List<String> getObjectKeys()

The list of the objects to be exported

Returns:

the value

getBucketName

public String getBucketName()

The name of the Object Storage Bucket where the objects will be exported to

Returns:

the value

getFileName

public String getFileName()

Name of the exported zip file.

Returns:

the value

getObjectStorageTenancyId

public String getObjectStorageTenancyId()

Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)

Returns:

the value

getObjectStorageRegion

public String getObjectStorageRegion()

Region of the object storage (if using object storage of different region)

Returns:

the value

getAreReferencesIncluded

public Boolean getAreReferencesIncluded()

Controls if the references will be exported along with the objects

Returns:

the value

getIsObjectOverwriteEnabled

public Boolean getIsObjectOverwriteEnabled()

Flag to control whether to overwrite the object if it is already present at the provided object storage location.

Returns:

the value

getFilters

public List<String> getFilters()

Export multiple objects based on filters.

Returns:

the value

getStatus

public ExportRequest.Status getStatus()

Export Objects request status.

Returns:

the value

getCreatedBy

public String getCreatedBy()

Name of the user who initiated export request.

Returns:

the value

getTotalExportedObjectCount

public Integer getTotalExportedObjectCount()

Number of objects that are exported.

Returns:

the value

getTimeStartedInMillis

public Long getTimeStartedInMillis()

Time at which the request started getting processed.

Returns:

the value

getTimeEndedInMillis

public Long getTimeEndedInMillis()

Time at which the request was completely processed.

Returns:

the value

getErrorMessages

public Map<String,String> getErrorMessages()

Contains key of the error

Returns:

the value

getExportedItems

public List<ExportObjectMetadataSummary> getExportedItems()

The array of exported object details.

Returns:

the value

getReferencedItems

public String getReferencedItems()

The array of exported referenced objects.

Returns:

the value

getName

public String getName()

Name of the export request.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel