Class ExportRequest
- java.lang.Object
-
- com.broadleafcommerce.common.dataexport.domain.ExportRequest
-
- All Implemented Interfaces:
Serializable
public class ExportRequest extends Object implements Serializable
This is the request DTO which should be sent by API callers to request the creation of aExport
.- Author:
- Samarth Dhruva (samarthd)
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ExportRequest()
ExportRequest(String name, String fileType, List<String> inclusions, List<String> exclusions, String parentId, String exportingSandboxId, String exportingApplicationId, String exportingCatalogId, String exportingCustomerContextId, String timeZoneId, Map<String,Object> parameters)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(Object other)
boolean
equals(Object o)
List<String>
getExclusions()
String
getExportingApplicationId()
The ID of the application that that the export's data will be sourced from.String
getExportingCatalogId()
The ID of the catalog that that the export's data will be sourced from.String
getExportingCustomerContextId()
The ID of the customer context that that the export's data will be sourced from.String
getExportingSandboxId()
The ID of the sandbox that the export's data will be sourced from.String
getFileType()
The type of file that the export should ultimately produce for download by the user.List<String>
getInclusions()
String
getName()
The name of this export.Map<String,Object>
getParameters()
String
getParentId()
String
getTimeZoneId()
int
hashCode()
void
setExclusions(List<String> exclusions)
void
setExportingApplicationId(String exportingApplicationId)
The ID of the application that that the export's data will be sourced from.void
setExportingCatalogId(String exportingCatalogId)
The ID of the catalog that that the export's data will be sourced from.void
setExportingCustomerContextId(String exportingCustomerContextId)
The ID of the customer context that that the export's data will be sourced from.void
setExportingSandboxId(String exportingSandboxId)
The ID of the sandbox that the export's data will be sourced from.void
setFileType(String fileType)
The type of file that the export should ultimately produce for download by the user.void
setInclusions(List<String> inclusions)
void
setName(String name)
The name of this export.void
setParameters(Map<String,Object> parameters)
void
setParentId(String parentId)
void
setTimeZoneId(String timeZoneId)
String
toString()
-
-
-
Constructor Detail
-
ExportRequest
public ExportRequest()
-
ExportRequest
public ExportRequest(@Nullable String name, String fileType, List<String> inclusions, List<String> exclusions, @Nullable String parentId, @Nullable String exportingSandboxId, @Nullable String exportingApplicationId, @Nullable String exportingCatalogId, @Nullable String exportingCustomerContextId, @Nullable String timeZoneId, Map<String,Object> parameters)
-
-
Method Detail
-
getName
@Nullable public String getName()
The name of this export. If this is leftnull
, a name will be generated with the following format:$target + " - " + $timestamp
- See Also:
Export.name
,Export.target
-
getFileType
public String getFileType()
The type of file that the export should ultimately produce for download by the user.- See Also:
Export.fileType
-
getInclusions
public List<String> getInclusions()
- See Also:
Export.inclusions
-
getExclusions
public List<String> getExclusions()
- See Also:
Export.exclusions
-
getParentId
@Nullable public String getParentId()
- See Also:
Export.getParentId()
-
getExportingSandboxId
@Nullable public String getExportingSandboxId()
The ID of the sandbox that the export's data will be sourced from.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
getExportingApplicationId
@Nullable public String getExportingApplicationId()
The ID of the application that that the export's data will be sourced from.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
getExportingCatalogId
@Nullable public String getExportingCatalogId()
The ID of the catalog that that the export's data will be sourced from.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
getExportingCustomerContextId
@Nullable public String getExportingCustomerContextId()
The ID of the customer context that that the export's data will be sourced from.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
getTimeZoneId
@Nullable public String getTimeZoneId()
- See Also:
Export.getTimeZoneId()
-
getParameters
public Map<String,Object> getParameters()
- See Also:
Export.getParameters()
-
setName
public void setName(@Nullable String name)
The name of this export. If this is leftnull
, a name will be generated with the following format:$target + " - " + $timestamp
- See Also:
Export.name
,Export.target
-
setFileType
public void setFileType(String fileType)
The type of file that the export should ultimately produce for download by the user.- See Also:
Export.fileType
-
setInclusions
public void setInclusions(List<String> inclusions)
- See Also:
Export.inclusions
-
setExclusions
public void setExclusions(List<String> exclusions)
- See Also:
Export.exclusions
-
setParentId
public void setParentId(@Nullable String parentId)
- See Also:
Export.getParentId()
-
setExportingSandboxId
public void setExportingSandboxId(@Nullable String exportingSandboxId)
The ID of the sandbox that the export's data will be sourced from.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
setExportingApplicationId
public void setExportingApplicationId(@Nullable String exportingApplicationId)
The ID of the application that that the export's data will be sourced from.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
setExportingCatalogId
public void setExportingCatalogId(@Nullable String exportingCatalogId)
The ID of the catalog that that the export's data will be sourced from.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
setExportingCustomerContextId
public void setExportingCustomerContextId(@Nullable String exportingCustomerContextId)
The ID of the customer context that that the export's data will be sourced from.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
setTimeZoneId
public void setTimeZoneId(@Nullable String timeZoneId)
- See Also:
Export.getTimeZoneId()
-
setParameters
public void setParameters(Map<String,Object> parameters)
- See Also:
Export.getParameters()
-
canEqual
protected boolean canEqual(Object other)
-
-