Twin (Eclipse Ditto :: Java Client 3.5.0 API)

All Superinterfaces:

CommonManagement<TwinThingHandle,TwinFeatureHandle>, FeatureChangeRegistration, HandlerDeregistration, ThingAttributeChangeRegistration, ThingChangeRegistration, ThingFeaturePropertiesChangeRegistration

All Known Implementing Classes:

TwinImpl
```
public interface Twin
extends CommonManagement<TwinThingHandle,TwinFeatureHandle>
```
Twin API of Eclipse Ditto acting as the entry point for managing and monitoring Twin Things, which are the digital representations (digital twins) of the actual devices being managed.

Since:

1.0.0

Field Summary
- Fields inherited from interface org.eclipse.ditto.client.management.CommonManagement
  CONSUMPTION_PARAM_EXTRA_FIELDS, CONSUMPTION_PARAM_FILTER, CONSUMPTION_PARAM_NAMESPACES

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`TwinSearchHandle`	`search()`	Retrieve the handle for search operations.
`java.util.concurrent.CompletionStage<java.lang.Void>`	`startConsumption()`	Start consuming changes on this `twin()` channel.
`java.util.concurrent.CompletionStage<java.lang.Void>`	`startConsumption(Option<?>... consumptionOptions)`	Start consuming changes on this `twin()` channel with the passed `consumptionOptions`.

Methods inherited from interface org.eclipse.ditto.client.management.CommonManagement
create, create, create, create, create, create, create, create, create, create, create, delete, forFeature, forId, merge, merge, put, put, put, put, put, put, retrieve, retrieve, retrieve, retrieve, suspendConsumption, update, update

Methods inherited from interface org.eclipse.ditto.client.registration.FeatureChangeRegistration
registerForFeatureChanges, registerForFeatureChanges, registerForFeaturesChanges

Methods inherited from interface org.eclipse.ditto.client.registration.HandlerDeregistration
deregister

Methods inherited from interface org.eclipse.ditto.client.registration.ThingAttributeChangeRegistration
registerForAttributeChanges, registerForAttributeChanges, registerForAttributesChanges

Methods inherited from interface org.eclipse.ditto.client.registration.ThingChangeRegistration
registerForThingChanges

Methods inherited from interface org.eclipse.ditto.client.registration.ThingFeaturePropertiesChangeRegistration
registerForFeaturePropertyChanges, registerForFeaturePropertyChanges, registerForFeaturePropertyChanges

- Method Detail
  - startConsumption
```
java.util.concurrent.CompletionStage<java.lang.Void> startConsumption()
```
    Start consuming changes on this twin() channel.
    
    Specified by:
    
    startConsumption in interface CommonManagement<TwinThingHandle,TwinFeatureHandle>
    
    Returns:
    
    a CompletionStage that terminates when the start operation was successful or fails with ClientReconnectingException if the client is in a reconnecting state.
  - startConsumption
```
java.util.concurrent.CompletionStage<java.lang.Void> startConsumption(Option<?>... consumptionOptions)
```
    Start consuming changes on this twin() channel with the passed consumptionOptions.
    Specified by:
    
    startConsumption in interface CommonManagement<TwinThingHandle,TwinFeatureHandle>
    
    Parameters:
    
    consumptionOptions - specifies the ConsumptionOptions to apply. Pass them in via:
    Options.Consumption.namespaces("org.eclipse.ditto.namespace1","org.eclipse.ditto.namespace2"); Options.Consumption.filter("gt(attributes/counter,42)");
    
    Returns:
    
    a CompletionStage that terminates when the start operation was successful or fails with ClientReconnectingException if the client is in a reconnecting state.
  - search
```
TwinSearchHandle search()
```
    Retrieve the handle for search operations.
    
    Returns:
    
    the search handle.
    
    Since:
    
    1.1.0