Package kalix.javasdk.valueentity

Interface ValueEntity.Effect.Builder<S>

Type Parameters:
S - The type of the state for this entity.
Enclosing interface:
ValueEntity.Effect<T>
public static interface ValueEntity.Effect.Builder<S>
Construct the effect that is returned by the command handler. The effect describes next processing actions, such as updating state and sending a reply.

  • Method Details

    • updateState

      ValueEntity.Effect.OnSuccessBuilder<S> updateState(S newState)

    • deleteEntity

      ValueEntity.Effect.OnSuccessBuilder<S> deleteEntity()
      Delete the entity. No additional updates are allowed afterwards.

    • deleteState

      @Deprecated(since="1.1.5", forRemoval=true) ValueEntity.Effect.OnSuccessBuilder<S> deleteState()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Renamed to deleteEntity
      Delete the entity. No additional updates are allowed afterwards.

    • reply

      <T> ValueEntity.Effect<T> reply(T message)
      Create a message reply.
      Type Parameters:
      T - The type of the message that must be returned by this call.
      Parameters:
      message - The payload of the reply.
      Returns:
      A message reply.

    • reply

      <T> ValueEntity.Effect<T> reply(T message, Metadata metadata)
      Create a message reply.
      Type Parameters:
      T - The type of the message that must be returned by this call.
      Parameters:
      message - The payload of the reply.
      metadata - The metadata for the message.
      Returns:
      A message reply.

    • forward

      <T> ValueEntity.Effect<T> forward(DeferredCall<? extends Object,T> serviceCall)
      Create a forward reply.
      Type Parameters:
      T - The type of the message that must be returned by this call.
      Parameters:
      serviceCall - The service call representing the forward.
      Returns:
      A forward reply.

    • error

      <T> ValueEntity.Effect<T> error(String description)
      Create an error reply.
      Type Parameters:
      T - The type of the message that must be returned by this call.
      Parameters:
      description - The description of the error.
      Returns:
      An error reply.

    • error

      <T> ValueEntity.Effect<T> error(String description, io.grpc.Status.Code grpcErrorCode)
      Create an error reply.
      Type Parameters:
      T - The type of the message that must be returned by this call.
      Parameters:
      description - The description of the error.
      grpcErrorCode - A custom gRPC status code.
      Returns:
      An error reply.

    • error

      <T> ValueEntity.Effect<T> error(String description, StatusCode.ErrorCode httpErrorCode)
      Create an error reply with a custom status code. This status code will be translated to an HTTP or gRPC code depending on the type of service being exposed.
      Type Parameters:
      T - The type of the message that must be returned by this call.
      Parameters:
      description - The description of the error.
      httpErrorCode - A custom Kalix status code to represent the error.
      Returns:
      An error reply.