EntityOptions

All Superinterfaces:: kalix.javasdk.impl.ComponentOptions

All Known Subinterfaces:: EventSourcedEntityOptions, ReplicatedEntityOptions, ValueEntityOptions

public interface EntityOptions extends kalix.javasdk.impl.ComponentOptions

Options used for configuring an entity.

Method Summary

Modifier and Type

Method

Description

Set<String>

forwardHeaders()

PassivationStrategy

passivationStrategy()

kalix.javasdk.impl.ComponentOptions

withForwardHeaders(Set<String> headers)

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

EntityOptions

withPassivationStrategy(PassivationStrategy strategy)

Create an entity option with the given passivation strategy.

Method Details
- passivationStrategy
  
  PassivationStrategy passivationStrategy()
  
  Returns:
  
  the passivation strategy for an entity
- withPassivationStrategy
  
  EntityOptions withPassivationStrategy(PassivationStrategy strategy)
  
  Create an entity option with the given passivation strategy.
  
  Parameters:
  
  strategy - to be used
  
  Returns:
  
  the entity option
- forwardHeaders
  
  Set<String> forwardHeaders()
  
  Specified by:
  
  forwardHeaders in interface kalix.javasdk.impl.ComponentOptions
  
  Returns:
  
  the headers requested to be forwarded as metadata (cannot be mutated, use withForwardHeaders)
- withForwardHeaders
  
  kalix.javasdk.impl.ComponentOptions withForwardHeaders(Set<String> headers)
  
  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