ValueEntityOptions

All Superinterfaces:: kalix.javasdk.impl.ComponentOptions, EntityOptions

public interface ValueEntityOptions extends EntityOptions

Root entity options for all value based entities.

Method Summary

Modifier and Type

Method

Description

static ValueEntityOptions

defaults()

Create a default entity option for a value based entity.

ValueEntityOptions

withForwardHeaders(Set<String> headers)

Ask Kalix to forward these headers from the incoming request as metadata headers for the incoming commands.

ValueEntityOptions

withPassivationStrategy(PassivationStrategy strategy)

Deprecated, for removal: This API element is subject to removal in a future version.
passivation strategy is ignored

Methods inherited from interface kalix.javasdk.EntityOptions
forwardHeaders, passivationStrategy

Method Details
- withPassivationStrategy
  
  @Deprecated(since="1.1.4", forRemoval=true) ValueEntityOptions withPassivationStrategy(PassivationStrategy strategy)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  passivation strategy is ignored
  
  Description copied from interface: EntityOptions
  
  Create an entity option with the given passivation strategy.
  
  Specified by:
  
  withPassivationStrategy in interface EntityOptions
  
  Parameters:
  
  strategy - to be used
  
  Returns:
  
  the entity option
- withForwardHeaders
  
  ValueEntityOptions withForwardHeaders(Set<String> headers)
  
  Description copied from interface: EntityOptions
  
  Ask Kalix to forward these headers from the incoming request as metadata headers for the incoming commands. By default, no headers except "X-Server-Timing" are forwarded.
  
  Specified by:
  
  withForwardHeaders in interface kalix.javasdk.impl.ComponentOptions
  
  Specified by:
  
  withForwardHeaders in interface EntityOptions
- defaults
  
  static ValueEntityOptions defaults()
  
  Create a default entity option for a value based entity.
  
  Returns:
  
  the entity option