Class SynchronizationFinalizationRequest
Object
BaseImportRequest
SynchronizationFinalizationRequest
- All Implemented Interfaces:
Serializable
The request defining synchronization finalization call properties.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanWhether the operation should continue if some of the finalization steps failed to execute.protected BooleanCaptures the rawcontinueOnErrorvalue provided by the REST API client, ornullif the client did not set it.Fields inherited from class BaseImportRequest
batchSize, DEFAULT_BATCH_SIZE, requestSource, saveResult, sendNotification, simulation -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuilder()protected booleanbooleanCaptures the rawcontinueOnErrorvalue provided by the REST API client, ornullif the client did not set it.Map<SynchronizationFinalizationRequest.SynchronizationFinalizationRequestBuilder.CustomFinalizationParameter, String> Deprecated.This parameter is deprecated and will be removed in the future.The synchronization finalization strategy used in the clean up action.If finalizationStrategy is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.The synchronization ID used to distinguish different synchronizations.inthashCode()booleanWhether the operation should continue if some of the finalization steps failed to execute.toString()Methods inherited from class BaseImportRequest
getBatchSize, getRequestSource, isSaveResult, isSendNotification, isSimulation, setBatchSize, setRequestSource, setSaveResult, setSendNotification, setSimulation
-
Field Details
-
continueOnError
@DefaultValue("false") protected boolean continueOnErrorWhether the operation should continue if some of the finalization steps failed to execute. The default value istrue.If
true, the valid steps are still committed to the database, which can lead to partial results being stored. -
continueOnErrorRaw
Captures the rawcontinueOnErrorvalue provided by the REST API client, ornullif the client did not set it. Used for monitoring purposes only.
-
-
Constructor Details
-
SynchronizationFinalizationRequest
public SynchronizationFinalizationRequest()
-
-
Method Details
-
builder
public static SynchronizationFinalizationRequest.SynchronizationFinalizationRequestBuilder builder() -
getSynchronizationId
The synchronization ID used to distinguish different synchronizations. -
getFinalizationStrategy
The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system. Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`. When you select `CHANGE_STATUS` you must also provide a value for `missingAssetStatusId`. -
getMissingAssetStatusId
If finalizationStrategy is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system. -
getFinalizationParameters
@Deprecated public Map<SynchronizationFinalizationRequest.SynchronizationFinalizationRequestBuilder.CustomFinalizationParameter,String> getFinalizationParameters()Deprecated.This parameter is deprecated and will be removed in the future. Please, use missingAssetStatusId. -
isContinueOnError
public boolean isContinueOnError()Whether the operation should continue if some of the finalization steps failed to execute. The default value istrue.If
true, the valid steps are still committed to the database, which can lead to partial results being stored. -
getContinueOnErrorRaw
Captures the rawcontinueOnErrorvalue provided by the REST API client, ornullif the client did not set it. Used for monitoring purposes only. -
toString
- Overrides:
toStringin classBaseImportRequest
-
equals
- Overrides:
equalsin classBaseImportRequest
-
canEqual
- Overrides:
canEqualin classBaseImportRequest
-
hashCode
public int hashCode()- Overrides:
hashCodein classBaseImportRequest
-