Interface ImportOperation
Represents the import status of a resource.
Example to create an instance using the builder pattern
ImportOperation importOperation = ImportOperation.builder()
.version(1)
.importContainerKey("{importContainerKey}")
.resourceKey("{resourceKey}")
.id("{id}")
.state(ProcessingState.PROCESSING)
.createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.expiresAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.build()
-
Method Summary
Modifier and TypeMethodDescriptionstatic ImportOperationBuilder
builder()
builder factory method for ImportOperationstatic ImportOperationBuilder
builder
(ImportOperation template) create builder for ImportOperation instancecopyDeep()
static ImportOperation
deepCopy
(ImportOperation template) factory method to create a deep copy of ImportOperation@NotNull ZonedDateTime
Date and time (UTC) the ImportOperation was created.@Valid List<ErrorObject>
Contains errors if the import was unsuccessful.@NotNull ZonedDateTime
Date and time (UTC) the ImportOperation will be deleted.@NotNull String
getId()
Unique identifier of the ImportOperation.@NotNull String
key
of the ImportContainer.@NotNull ZonedDateTime
Date and time (UTC) the ImportOperation was last updated.@NotNull String
key
of the resource being imported.Theversion
of the imported resource when the import was successful.@NotNull ProcessingState
getState()
The import status of the resource.@Valid List<UnresolvedReferences>
If the resource being imported contains references to resources which do not exist, these references are contained within this array.@NotNull Long
Current version of the ImportOperation.static ImportOperation
of()
factory methodstatic ImportOperation
of
(ImportOperation template) factory method to create a shallow copy ImportOperationvoid
setCreatedAt
(ZonedDateTime createdAt) Date and time (UTC) the ImportOperation was created.void
setErrors
(ErrorObject... errors) Contains errors if the import was unsuccessful.void
setErrors
(List<ErrorObject> errors) Contains errors if the import was unsuccessful.void
setExpiresAt
(ZonedDateTime expiresAt) Date and time (UTC) the ImportOperation will be deleted.void
Unique identifier of the ImportOperation.void
setImportContainerKey
(String importContainerKey) key
of the ImportContainer.void
setLastModifiedAt
(ZonedDateTime lastModifiedAt) Date and time (UTC) the ImportOperation was last updated.void
setResourceKey
(String resourceKey) key
of the resource being imported.void
setResourceVersion
(Long resourceVersion) Theversion
of the imported resource when the import was successful.void
setState
(ProcessingState state) The import status of the resource.void
setUnresolvedReferences
(UnresolvedReferences... unresolvedReferences) If the resource being imported contains references to resources which do not exist, these references are contained within this array.void
setUnresolvedReferences
(List<UnresolvedReferences> unresolvedReferences) If the resource being imported contains references to resources which do not exist, these references are contained within this array.void
setVersion
(Long version) Current version of the ImportOperation.static com.fasterxml.jackson.core.type.TypeReference<ImportOperation>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
withImportOperation
(Function<ImportOperation, T> helper) accessor map function
-
Method Details
-
getVersion
Current version of the ImportOperation.
- Returns:
- version
-
getImportContainerKey
key
of the ImportContainer.- Returns:
- importContainerKey
-
getResourceKey
key
of the resource being imported.- Returns:
- resourceKey
-
getId
Unique identifier of the ImportOperation.
- Returns:
- id
-
getState
The import status of the resource. If
rejected
orvalidationFailed
, the import was unsuccessful.- Returns:
- state
-
getResourceVersion
Long getResourceVersion()The
version
of the imported resource when the import was successful.- Returns:
- resourceVersion
-
getErrors
Contains errors if the import was unsuccessful. See Errors.
- Returns:
- errors
-
getUnresolvedReferences
If the resource being imported contains references to resources which do not exist, these references are contained within this array.
- Returns:
- unresolvedReferences
-
getCreatedAt
Date and time (UTC) the ImportOperation was created.
- Returns:
- createdAt
-
getLastModifiedAt
Date and time (UTC) the ImportOperation was last updated.
- Returns:
- lastModifiedAt
-
getExpiresAt
Date and time (UTC) the ImportOperation will be deleted.
- Returns:
- expiresAt
-
setVersion
Current version of the ImportOperation.
- Parameters:
version
- value to be set
-
setImportContainerKey
key
of the ImportContainer.- Parameters:
importContainerKey
- value to be set
-
setResourceKey
key
of the resource being imported.- Parameters:
resourceKey
- value to be set
-
setId
Unique identifier of the ImportOperation.
- Parameters:
id
- value to be set
-
setState
The import status of the resource. If
rejected
orvalidationFailed
, the import was unsuccessful.- Parameters:
state
- value to be set
-
setResourceVersion
The
version
of the imported resource when the import was successful.- Parameters:
resourceVersion
- value to be set
-
setErrors
Contains errors if the import was unsuccessful. See Errors.
- Parameters:
errors
- values to be set
-
setErrors
Contains errors if the import was unsuccessful. See Errors.
- Parameters:
errors
- values to be set
-
setUnresolvedReferences
If the resource being imported contains references to resources which do not exist, these references are contained within this array.
- Parameters:
unresolvedReferences
- values to be set
-
setUnresolvedReferences
If the resource being imported contains references to resources which do not exist, these references are contained within this array.
- Parameters:
unresolvedReferences
- values to be set
-
setCreatedAt
Date and time (UTC) the ImportOperation was created.
- Parameters:
createdAt
- value to be set
-
setLastModifiedAt
Date and time (UTC) the ImportOperation was last updated.
- Parameters:
lastModifiedAt
- value to be set
-
setExpiresAt
Date and time (UTC) the ImportOperation will be deleted.
- Parameters:
expiresAt
- value to be set
-
of
factory method- Returns:
- instance of ImportOperation
-
of
factory method to create a shallow copy ImportOperation- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
copyDeep
ImportOperation copyDeep() -
deepCopy
factory method to create a deep copy of ImportOperation- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for ImportOperation- Returns:
- builder
-
builder
create builder for ImportOperation instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withImportOperation
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-