package backoffice
- Alphabetic
- Public
- Protected
Type Members
- trait BackofficeService extends AnyRef
The backoffice service allows accessing backoffice functions of the proxy.
The backoffice service allows accessing backoffice functions of the proxy.
- Annotations
- @AkkaGrpcGenerated()
- final case class Config(messageBroker: Option[MessageBrokerConfig] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Config] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class DescribeViewRequest(viewId: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DescribeViewRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class DropViewRequest(name: String = "", force: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DropViewRequest] with Product with Serializable
- force
when the view is currently in use by this node, we only allow deleting it when this flag is true.
- Annotations
- @SerialVersionUID()
- final case class DropViewResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DropViewResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class EntityState(componentName: String = "", id: String = "", state: Option[Any] = _root_.scala.None, sequence: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EntityState] with Product with Serializable
- componentName
The name of the entity.
- id
The id of the entity.
- state
The state.
- sequence
The sequence number of the entity, if the entity type supports sequence numbers.
- Annotations
- @SerialVersionUID()
- final case class EventSourcedEntityEvent(componentName: String = "", id: String = "", sequence: Long = 0L, offset: String = "", timestamp: Option[Timestamp] = _root_.scala.None, event: Option[Any] = _root_.scala.None, state: Option[Any] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EventSourcedEntityEvent] with Product with Serializable
- componentName
The name of the service that the entity is part of.
- id
The id of the entity
- sequence
The 1 based sequence number for the event.
- offset
An opaque value that is used for ordering of events between different entity types.
- timestamp
When the event was created.
- event
The event payload
- state
The state, only present if include_state was true in the request.
- Annotations
- @SerialVersionUID()
- final case class GetConfigRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetConfigRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class GetEntityStateRequest(componentName: String = "", id: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetEntityStateRequest] with Product with Serializable
- componentName
The name of the entity.
- id
The id of the entity.
- Annotations
- @SerialVersionUID()
- final case class GetStatefulComponentStateRequest(componentName: String = "", id: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetStatefulComponentStateRequest] with Product with Serializable
- componentName
The name of the component, could be an Entity or a Workflow.
- id
The id of the component.
- Annotations
- @SerialVersionUID()
- final case class GetTimers(replyTo: String = "", limit: Int = 0, name: String = "", from: Option[Timestamp] = _root_.scala.None, to: Option[Timestamp] = _root_.scala.None, failingOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetTimers] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class GetWorkflowExecutionRequest(componentName: String = "", id: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetWorkflowExecutionRequest] with Product with Serializable
- componentName
The name of the Workflow component
- id
The id of the component.
- Annotations
- @SerialVersionUID()
- final case class ListComponentsRequest(pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListComponentsRequest] with Product with Serializable
- pageSize
The size of the pages to request. Defaults to 100. Must not be more than 100.
- pageToken
The token of the page to request. This is an opaque value that must be copied, unmodified, from the the next_page_token field of a returned response. The request that produced this token must be identical to this request, aside from the token itself.
- Annotations
- @SerialVersionUID()
- final case class ListComponentsResponse(components: Seq[Component] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListComponentsResponse] with Product with Serializable
- components
The components served by this service.
- nextPageToken
The token for the next page. If there are more pages, this field will be non empty, and may be passed in the page_token field of the request to retrieve the next page.
- Annotations
- @SerialVersionUID()
- final case class ListEntityIdsRequest(componentName: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListEntityIdsRequest] with Product with Serializable
- componentName
The name of the service for the entity.
- pageSize
The size of the pages to request. Defaults to 100. Must not be more than 100.
- pageToken
The token of the page to request. This is an opaque value that must be copied, unmodified, from the the next_page_token field of a returned response. The request that produced this token must be identical to this request, aside from the token itself.
- Annotations
- @SerialVersionUID()
- final case class ListEntityIdsResponse(ids: Seq[String] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListEntityIdsResponse] with Product with Serializable
- ids
The entity ids for this entity.
- nextPageToken
The token for the next page. If there are more pages, this field will be non empty, and may be passed in the page_token field of the request to retrieve the next page.
- Annotations
- @SerialVersionUID()
- final case class ListEventSourcedEntityEventsRequest(componentName: String = "", id: String = "", includeState: Boolean = false, pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListEventSourcedEntityEventsRequest] with Product with Serializable
- componentName
The name of the service for the entity.
- id
The id of the entity to list the events of.
- includeState
Whether the state of the entity should be included with each event.
- pageSize
The size of the pages to request. Defaults to 100. Must not be more than 100.
- pageToken
The token of the page to request. This is an opaque value that must be copied, unmodified, from the the next_page_token field of a returned response. The request that produced this token must be identical to this request, aside from the token itself.
- Annotations
- @SerialVersionUID()
- final case class ListEventSourcedEntityEventsResponse(events: Seq[EventSourcedEntityEvent] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListEventSourcedEntityEventsResponse] with Product with Serializable
- events
The events for this entity.
- nextPageToken
The token for the next page. If there are more pages, this field will be non empty, and may be passed in the page_token field of the request to retrieve the next page.
- Annotations
- @SerialVersionUID()
- final case class ListStatefulComponentIdsRequest(componentName: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListStatefulComponentIdsRequest] with Product with Serializable
- componentName
The name of the component, could be an Entity or a Workflow.
- pageSize
The size of the pages to request. Defaults to 100. Must not be more than 100.
- pageToken
The token of the page to request. This is an opaque value that must be copied, unmodified, from the the next_page_token field of a returned response. The request that produced this token must be identical to this request, aside from the token itself.
- Annotations
- @SerialVersionUID()
- final case class ListStatefulComponentIdsResponse(ids: Seq[String] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListStatefulComponentIdsResponse] with Product with Serializable
- ids
The entity ids for this entity.
- nextPageToken
The token for the next page. If there are more pages, this field will be non empty, and may be passed in the page_token field of the request to retrieve the next page.
- Annotations
- @SerialVersionUID()
- final case class ListTimersRequest(pageSize: Int = 0, name: String = "", from: Option[Timestamp] = _root_.scala.None, to: Option[Timestamp] = _root_.scala.None, failingOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListTimersRequest] with Product with Serializable
- pageSize
default and maximum = 100
- name
a full timer name or part of it
- failingOnly
TODO pagination
- Annotations
- @SerialVersionUID()
- final case class ListTimersResponse(timers: Seq[RegisteredTimer] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListTimersResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class ListViewsRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListViewsRequest] with Product with Serializable
could add a token later
could add a token later
- Annotations
- @SerialVersionUID()
- final case class ListViewsResponse(views: Seq[View] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListViewsResponse] with Product with Serializable
- views
could add a next_token later
- Annotations
- @SerialVersionUID()
- final case class MessageBrokerConfig(type: String = "", address: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MessageBrokerConfig] with Product with Serializable
- type
kafka, pubsub, etc
- address
comma separated host:port
- Annotations
- @SerialVersionUID()
- final case class ProjectionId(name: String = "", key: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ProjectionId] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class ProjectionStatus(paused: Boolean = false, offset: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ProjectionStatus] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class RegisteredTimer(name: String = "", componentName: String = "", commandName: String = "", payload: Option[Any] = _root_.scala.None, whenToRun: Option[Timestamp] = _root_.scala.None, retries: Int = 0, maxRetries: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RegisteredTimer] with Product with Serializable
- componentName
The name of the component to call.
- commandName
The name of the command to call.
- payload
The payload.
- Annotations
- @SerialVersionUID()
- final case class StatefulComponentState(componentName: String = "", id: String = "", state: Option[Any] = _root_.scala.None, sequence: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[StatefulComponentState] with Product with Serializable
- componentName
The name of the component.
- id
The id of the component.
- state
The state.
- sequence
The sequence number, if the component type supports sequence numbers.
- Annotations
- @SerialVersionUID()
- final case class UpdateProjectionOffsetReq(projectionId: Option[ProjectionId] = _root_.scala.None, offset: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UpdateProjectionOffsetReq] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class View(name: String = "", lastUpdated: Option[Timestamp] = _root_.scala.None, active: Boolean = false, legacy: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[View] with Product with Serializable
- active
warning: when false, *this* node thinks this view is no longer active. during a rolling update, other nodes might still be actively using this index.
- Annotations
- @SerialVersionUID()
- final case class ViewDescription(viewId: String = "", serviceName: String = "", sources: Seq[String] = _root_.scala.Seq.empty, queries: Seq[ViewDescriptionQuery] = _root_.scala.Seq.empty, tables: Seq[ViewDescriptionTable] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ViewDescription] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class ViewDescriptionColumn(columnName: String = "", columnType: String = "", indexType: String = "", nullable: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ViewDescriptionColumn] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class ViewDescriptionQuery(methodName: String = "", query: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ViewDescriptionQuery] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class ViewDescriptionTable(tableName: String = "", columns: Seq[ViewDescriptionColumn] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ViewDescriptionTable] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class WorkflowExecution(typeId: String = "", id: String = "", status: String = "", userState: Option[Any] = _root_.scala.None, startedAt: Option[Timestamp] = _root_.scala.None, finishedAt: Option[Timestamp] = _root_.scala.None, timedOutAfter: Option[Duration] = _root_.scala.None, currentStep: Option[WorkflowExecutionStep] = _root_.scala.None, steps: Seq[WorkflowExecutionStep] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[WorkflowExecution] with Product with Serializable
- status
not represented as enum to avoid complex release cycle for changes
- Annotations
- @SerialVersionUID()
- final case class WorkflowExecutionStep(name: String = "", status: String = "", startedAt: Option[Timestamp] = _root_.scala.None, finishedAt: Option[Timestamp] = _root_.scala.None, input: Option[Any] = _root_.scala.None, result: Option[Any] = _root_.scala.None, attempts: Int = 0, lastFailureMessage: String = "", triggeredBy: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[WorkflowExecutionStep] with Product with Serializable
- status
not represented as enum to avoid complex release cycle for changes
- Annotations
- @SerialVersionUID()
Value Members
- object BackofficeProto extends GeneratedFileObject
- object BackofficeService extends ServiceDescription
- Annotations
- @AkkaGrpcGenerated()
- object BackofficeServiceHandler
- Annotations
- @ApiMayChange() @AkkaGrpcGenerated()
- object Config extends GeneratedMessageCompanion[Config]
- object DescribeViewRequest extends GeneratedMessageCompanion[DescribeViewRequest]
- object DropViewRequest extends GeneratedMessageCompanion[DropViewRequest]
- object DropViewResponse extends GeneratedMessageCompanion[DropViewResponse]
- object EntityState extends GeneratedMessageCompanion[EntityState]
- object EventSourcedEntityEvent extends GeneratedMessageCompanion[EventSourcedEntityEvent]
- object GetConfigRequest extends GeneratedMessageCompanion[GetConfigRequest]
- object GetEntityStateRequest extends GeneratedMessageCompanion[GetEntityStateRequest]
- object GetStatefulComponentStateRequest extends GeneratedMessageCompanion[GetStatefulComponentStateRequest]
- object GetTimers extends GeneratedMessageCompanion[GetTimers]
- object GetWorkflowExecutionRequest extends GeneratedMessageCompanion[GetWorkflowExecutionRequest]
- object ListComponentsRequest extends GeneratedMessageCompanion[ListComponentsRequest]
- object ListComponentsResponse extends GeneratedMessageCompanion[ListComponentsResponse]
- object ListEntityIdsRequest extends GeneratedMessageCompanion[ListEntityIdsRequest]
- object ListEntityIdsResponse extends GeneratedMessageCompanion[ListEntityIdsResponse]
- object ListEventSourcedEntityEventsRequest extends GeneratedMessageCompanion[ListEventSourcedEntityEventsRequest]
- object ListEventSourcedEntityEventsResponse extends GeneratedMessageCompanion[ListEventSourcedEntityEventsResponse]
- object ListStatefulComponentIdsRequest extends GeneratedMessageCompanion[ListStatefulComponentIdsRequest]
- object ListStatefulComponentIdsResponse extends GeneratedMessageCompanion[ListStatefulComponentIdsResponse]
- object ListTimersRequest extends GeneratedMessageCompanion[ListTimersRequest]
- object ListTimersResponse extends GeneratedMessageCompanion[ListTimersResponse]
- object ListViewsRequest extends GeneratedMessageCompanion[ListViewsRequest]
- object ListViewsResponse extends GeneratedMessageCompanion[ListViewsResponse]
- object MessageBrokerConfig extends GeneratedMessageCompanion[MessageBrokerConfig]
- object ProjectionId extends GeneratedMessageCompanion[ProjectionId]
- object ProjectionStatus extends GeneratedMessageCompanion[ProjectionStatus]
- object RegisteredTimer extends GeneratedMessageCompanion[RegisteredTimer]
- object StatefulComponentState extends GeneratedMessageCompanion[StatefulComponentState]
- object UpdateProjectionOffsetReq extends GeneratedMessageCompanion[UpdateProjectionOffsetReq]
- object View extends GeneratedMessageCompanion[View]
- object ViewDescription extends GeneratedMessageCompanion[ViewDescription]
- object ViewDescriptionColumn extends GeneratedMessageCompanion[ViewDescriptionColumn]
- object ViewDescriptionQuery extends GeneratedMessageCompanion[ViewDescriptionQuery]
- object ViewDescriptionTable extends GeneratedMessageCompanion[ViewDescriptionTable]
- object WorkflowExecution extends GeneratedMessageCompanion[WorkflowExecution]
- object WorkflowExecutionStep extends GeneratedMessageCompanion[WorkflowExecutionStep]