Class BulkUpdateRequest
- java.lang.Object
-
- com.broadleafcommerce.bulk.domain.BulkUpdateRequest
-
- All Implemented Interfaces:
Serializable
public class BulkUpdateRequest extends Object implements Serializable
This is the request DTO which should be sent by API callers to request the creation of aBulkUpdate
.- Author:
- Samarth Dhruva (samarthd)
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description BulkUpdateRequest()
BulkUpdateRequest(String name, String updatingSandboxName, String type, List<String> inclusions, List<String> exclusions, String payload, String updatingApplicationId, String updatingCustomerContextId, String updatingCatalogId, boolean productionBulkUpdate)
Manual constructor to utilizeJsonDeserialize
forpayload
.
-
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()
List<String>
getInclusions()
String
getName()
String
getPayload()
String
getType()
String
getUpdatingApplicationId()
The ID of the application in which the update will be applied.String
getUpdatingCatalogId()
The ID of the catalog in which the update will be applied.String
getUpdatingCustomerContextId()
The ID of the customer context in which the update will be applied.String
getUpdatingSandboxName()
int
hashCode()
boolean
isProductionBulkUpdate()
void
setExclusions(List<String> exclusions)
void
setInclusions(List<String> inclusions)
void
setName(String name)
void
setPayload(String payload)
void
setProductionBulkUpdate(boolean productionBulkUpdate)
void
setType(String type)
void
setUpdatingApplicationId(String updatingApplicationId)
The ID of the application in which the update will be applied.void
setUpdatingCatalogId(String updatingCatalogId)
The ID of the catalog in which the update will be applied.void
setUpdatingCustomerContextId(String updatingCustomerContextId)
The ID of the customer context in which the update will be applied.void
setUpdatingSandboxName(String updatingSandboxName)
String
toString()
-
-
-
Constructor Detail
-
BulkUpdateRequest
public BulkUpdateRequest(String name, @Nullable String updatingSandboxName, String type, List<String> inclusions, List<String> exclusions, String payload, String updatingApplicationId, String updatingCustomerContextId, String updatingCatalogId, boolean productionBulkUpdate)
Manual constructor to utilizeJsonDeserialize
forpayload
.
-
BulkUpdateRequest
public BulkUpdateRequest()
-
-
Method Detail
-
getName
public String getName()
- See Also:
BulkUpdate.name
-
getType
public String getType()
- See Also:
BulkUpdate.type
-
getInclusions
public List<String> getInclusions()
- See Also:
BulkUpdate.inclusions
-
getExclusions
public List<String> getExclusions()
- See Also:
BulkUpdate.exclusions
-
getPayload
public String getPayload()
-
getUpdatingApplicationId
public String getUpdatingApplicationId()
The ID of the application in which the update will be applied.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
getUpdatingCatalogId
public String getUpdatingCatalogId()
The ID of the catalog in which the update will be applied.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
getUpdatingCustomerContextId
public String getUpdatingCustomerContextId()
The ID of the customer context in which the update will be applied.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
isProductionBulkUpdate
public boolean isProductionBulkUpdate()
- See Also:
BulkUpdate.isProductionBulkUpdate()
-
getUpdatingSandboxName
public String getUpdatingSandboxName()
- See Also:
BulkUpdate.getUpdatingSandboxName()
-
setName
public void setName(String name)
- See Also:
BulkUpdate.name
-
setType
public void setType(String type)
- See Also:
BulkUpdate.type
-
setInclusions
public void setInclusions(List<String> inclusions)
- See Also:
BulkUpdate.inclusions
-
setExclusions
public void setExclusions(List<String> exclusions)
- See Also:
BulkUpdate.exclusions
-
setPayload
public void setPayload(String payload)
-
setUpdatingApplicationId
public void setUpdatingApplicationId(String updatingApplicationId)
The ID of the application in which the update will be applied.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
setUpdatingCatalogId
public void setUpdatingCatalogId(String updatingCatalogId)
The ID of the catalog in which the update will be applied.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
setUpdatingCustomerContextId
public void setUpdatingCustomerContextId(String updatingCustomerContextId)
The ID of the customer context in which the update will be applied.If not supplied, the value will be sourced from the request's
ContextInfo
.
-
setProductionBulkUpdate
public void setProductionBulkUpdate(boolean productionBulkUpdate)
- See Also:
BulkUpdate.isProductionBulkUpdate()
-
setUpdatingSandboxName
public void setUpdatingSandboxName(String updatingSandboxName)
- See Also:
BulkUpdate.getUpdatingSandboxName()
-
canEqual
protected boolean canEqual(Object other)
-
-