io.cdap.cdap.api.dataset

Interface Reconfigurable

All Known Implementing Classes:

CompositeDatasetDefinition, CounterTimeseriesTableDefinition, IndexedObjectStoreDefinition, IndexedTableDefinition, KeyValueTableDefinition, TimeseriesTableDefinition

public interface Reconfigurable

Interface implemented by DatasetDefinitions that have a way to reconfigure the dataset properties. It is optional for a dataset type to implement this interface; if not implemented, the dataset system will assume that no compatibility check is required and call DatasetDefinition.configure(String, DatasetProperties) instead to obtain the new dataset specification.

Method Summary

Modifier and Type	Method and Description
DatasetSpecification	reconfigure(String instanceName, DatasetProperties newProperties, DatasetSpecification currentSpec) Validates the new properties, including a compatibility check with the existing spec, and returns a new dataset specification for the dataset instance.

Method Detail

reconfigure

DatasetSpecification reconfigure(String instanceName,
                                 DatasetProperties newProperties,
                                 DatasetSpecification currentSpec)
                          throws IncompatibleUpdateException

Validates the new properties, including a compatibility check with the existing spec, and returns a new dataset specification for the dataset instance.

Parameters:

newProperties - the updated dataset properties, to be validated by this method

currentSpec - the current specification of the dataset

Returns:

a new dataset specification, created from the new properties

Throws:

IncompatibleUpdateException - if the new properties are not compatible with the existing dataset