com.commercetools.importapi.models.importcontainers

Interface ImportContainer

All Known Implementing Classes:

ImportContainerImpl

public interface ImportContainer

Serves as the entry point of resources. An Import Container is not resource type-specific.

Example to create an instance using the builder pattern

     ImportContainer importContainer = ImportContainer.builder()
             .key("{key}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .build()
 

Method Summary

Modifier and Type	Method and Description
static ImportContainerBuilder	builder()
static ImportContainerBuilder	builder(ImportContainer template)
@NotNull ZonedDateTime	getCreatedAt() The time when the ImportContainer was created.
@NotNull String	getKey() User-defined unique identifier for the ImportContainer.
@NotNull ZonedDateTime	getLastModifiedAt() The last time when the ImportContainer was modified.
ImportResourceType	getResourceType() The resource type the ImportContainer is able to handle.
@NotNull Long	getVersion() The version of the ImportContainer.
static ImportContainer	of()
static ImportContainer	of(ImportContainer template)
void	setCreatedAt(ZonedDateTime createdAt)
void	setKey(String key)
void	setLastModifiedAt(ZonedDateTime lastModifiedAt)
void	setResourceType(ImportResourceType resourceType)
void	setVersion(Long version)
static com.fasterxml.jackson.core.type.TypeReference<ImportContainer>	typeReference()
default <T> T	withImportContainer(Function<ImportContainer,T> helper)

Method Detail

getKey

@NotNull
@NotNull String getKey()

User-defined unique identifier for the ImportContainer. Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).

getResourceType

ImportResourceType getResourceType()

The resource type the ImportContainer is able to handle. If not present, the ImportContainer is able to import all of the supported ImportResourceTypes.

getVersion

@NotNull
@NotNull Long getVersion()

The version of the ImportContainer.

getCreatedAt

@NotNull
@NotNull ZonedDateTime getCreatedAt()

The time when the ImportContainer was created.

getLastModifiedAt

@NotNull
@NotNull ZonedDateTime getLastModifiedAt()

The last time when the ImportContainer was modified.

setKey

void setKey(String key)

setResourceType

void setResourceType(ImportResourceType resourceType)

setVersion

void setVersion(Long version)

setCreatedAt

void setCreatedAt(ZonedDateTime createdAt)

setLastModifiedAt

void setLastModifiedAt(ZonedDateTime lastModifiedAt)

of

static ImportContainer of()

of

static ImportContainer of(ImportContainer template)

builder

static ImportContainerBuilder builder()

builder

static ImportContainerBuilder builder(ImportContainer template)

withImportContainer

default <T> T withImportContainer(Function<ImportContainer,T> helper)

typeReference

static com.fasterxml.jackson.core.type.TypeReference<ImportContainer> typeReference()