package component_backoffice
Ordering
- Alphabetic
Visibility
- Public
- Protected
Type Members
- final case class Acl(allowed: Seq[PrincipalMatcher] = _root_.scala.Seq.empty, denied: Seq[PrincipalMatcher] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Acl] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class Component(type: String = "", name: String = "", typeId: String = "", messageSources: Seq[MessageSource] = _root_.scala.Seq.empty, messageDestinations: Seq[MessageDestination] = _root_.scala.Seq.empty, endpointDefinitions: Seq[EndpointDefinition] = _root_.scala.Seq.empty, acl: Option[Acl] = _root_.scala.None, viewDefinition: Option[ViewDefinition] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Component] with Product with Serializable
- viewDefinition
only available for a view component
- Annotations
- @SerialVersionUID()
- trait ComponentBackofficeService extends AnyRef
The backoffice service allows accessing component details from the runtime.
The backoffice service allows accessing component details from the runtime.
- Annotations
- @AkkaGrpcGenerated()
- final case class ComponentSource(type: String = "", name: String = "", typeId: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ComponentSource] 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 EndpointDefinition(endpoint: Endpoint = kalix.backoffice.component_backoffice.EndpointDefinition.Endpoint.Empty, acl: Option[Acl] = _root_.scala.None, viewQuery: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EndpointDefinition] with Product with Serializable
- viewQuery
only available for a view component
- Annotations
- @SerialVersionUID()
- final case class EventSourcedEntityEvent(sequence: Long = 0L, offset: String = "", timestamp: Option[Timestamp] = _root_.scala.None, event: String = "", eventType: String = "", rawEvent: Option[Any] = _root_.scala.None, state: String = "", stateType: String = "", rawState: Option[Any] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EventSourcedEntityEvent] with Product with Serializable
- 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 GetComponentsRequest(pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetComponentsRequest] 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 GetComponentsResponse(components: Seq[Component] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetComponentsResponse] with Product with Serializable
- 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 GetEventSourcedEntityEventsRequest(componentName: String = "", id: String = "", includeState: Boolean = false, pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetEventSourcedEntityEventsRequest] with Product with Serializable
- 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 GetEventSourcedEntityEventsResponse(componentName: String = "", id: String = "", events: Seq[EventSourcedEntityEvent] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetEventSourcedEntityEventsResponse] 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 GetStatefulComponentIdsRequest(componentName: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetStatefulComponentIdsRequest] 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 GetStatefulComponentIdsResponse(ids: Seq[String] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetStatefulComponentIdsResponse] 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 GetStatefulComponentStateRequest(componentName: String = "", id: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetStatefulComponentStateRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class GetStatefulComponentStateResponse(componentName: String = "", id: String = "", stateType: String = "", state: String = "", rawState: Option[Any] = _root_.scala.None, sequence: Long = 0L, deleted: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetStatefulComponentStateResponse] with Product with Serializable
- sequence
The sequence number, if the component type supports sequence numbers.
- 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 GetTimersRequest(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[GetTimersRequest] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class GetTimersResponse(timers: Seq[RegisteredTimer] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetTimersResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class GetViewStateRequest(viewId: String = "", table: String = "", subject: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetViewStateRequest] with Product with Serializable
- table
optional for single table views
- subject
e.g. entity id or workflow id
- Annotations
- @SerialVersionUID()
- final case class GetViewStateResponse(viewId: String = "", table: String = "", subject: String = "", stateType: String = "", state: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetViewStateResponse] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class GetViewsRequest(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetViewsRequest] with Product with Serializable
could add a token later
could add a token later
- Annotations
- @SerialVersionUID()
- final case class GetViewsResponse(views: Seq[View] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GetViewsResponse] with Product with Serializable
- views
could add a next_token later
- 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
- Annotations
- @SerialVersionUID()
- final case class GrpcEndpoint(method: String = "", requestType: String = "", responseType: String = "", serverStreaming: Boolean = false, transcoding: Option[HttpEndpoint] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[GrpcEndpoint] with Product with Serializable
- transcoding
user can use grpc with transcoding to HTTP
- Annotations
- @SerialVersionUID()
- final case class HttpEndpoint(method: String = "", path: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[HttpEndpoint] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class MessageDestination(destination: Destination = kalix.backoffice.component_backoffice.MessageDestination.Destination.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MessageDestination] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class MessageSource(source: Source = kalix.backoffice.component_backoffice.MessageSource.Source.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MessageSource] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class PrincipalMatcher(matcher: Matcher = kalix.backoffice.component_backoffice.PrincipalMatcher.Matcher.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PrincipalMatcher] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class RegisteredTimer(name: String = "", componentName: String = "", commandName: String = "", payload: String = "", rawPayload: 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
- Annotations
- @SerialVersionUID()
- final case class StatefulComponentState(componentName: String = "", id: String = "", state: Option[Any] = _root_.scala.None, sequence: Long = 0L, deleted: Boolean = false, 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 Stream(serviceName: String = "", streamId: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Stream] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class Topic(name: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Topic] 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 ViewDefinition(tableNames: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ViewDefinition] with Product with Serializable
- tableNames
some views might update multiple tables
- 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: String = "", userStateType: String = "", rawUserState: Option[Any] = _root_.scala.None, startedAt: Option[Timestamp] = _root_.scala.None, finishedAt: Option[Timestamp] = _root_.scala.None, timedOutAfter: Option[Duration] = _root_.scala.None, steps: Seq[WorkflowExecutionStep] = _root_.scala.Seq.empty, deleted: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[WorkflowExecution] with Product with Serializable
- Annotations
- @SerialVersionUID()
- final case class WorkflowExecutionStep(name: String = "", status: String = "", startedAt: Option[Timestamp] = _root_.scala.None, finishedAt: Option[Timestamp] = _root_.scala.None, input: String = "", rawInput: Option[Any] = _root_.scala.None, result: String = "", rawResult: 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
- Annotations
- @SerialVersionUID()
Value Members
- object Acl extends GeneratedMessageCompanion[Acl]
- object Component extends GeneratedMessageCompanion[Component]
- object ComponentBackofficeProto extends GeneratedFileObject
- object ComponentBackofficeService extends ServiceDescription
- Annotations
- @AkkaGrpcGenerated()
- object ComponentBackofficeServiceHandler
- Annotations
- @ApiMayChange() @AkkaGrpcGenerated()
- object ComponentSource extends GeneratedMessageCompanion[ComponentSource]
- object DescribeViewRequest extends GeneratedMessageCompanion[DescribeViewRequest]
- object EndpointDefinition extends GeneratedMessageCompanion[EndpointDefinition]
- object EventSourcedEntityEvent extends GeneratedMessageCompanion[EventSourcedEntityEvent]
- object GetComponentsRequest extends GeneratedMessageCompanion[GetComponentsRequest]
- object GetComponentsResponse extends GeneratedMessageCompanion[GetComponentsResponse]
- object GetEventSourcedEntityEventsRequest extends GeneratedMessageCompanion[GetEventSourcedEntityEventsRequest]
- object GetEventSourcedEntityEventsResponse extends GeneratedMessageCompanion[GetEventSourcedEntityEventsResponse]
- object GetStatefulComponentIdsRequest extends GeneratedMessageCompanion[GetStatefulComponentIdsRequest]
- object GetStatefulComponentIdsResponse extends GeneratedMessageCompanion[GetStatefulComponentIdsResponse]
- object GetStatefulComponentStateRequest extends GeneratedMessageCompanion[GetStatefulComponentStateRequest]
- object GetStatefulComponentStateResponse extends GeneratedMessageCompanion[GetStatefulComponentStateResponse]
- object GetTimers extends GeneratedMessageCompanion[GetTimers]
- object GetTimersRequest extends GeneratedMessageCompanion[GetTimersRequest]
- object GetTimersResponse extends GeneratedMessageCompanion[GetTimersResponse]
- object GetViewStateRequest extends GeneratedMessageCompanion[GetViewStateRequest]
- object GetViewStateResponse extends GeneratedMessageCompanion[GetViewStateResponse]
- object GetViewsRequest extends GeneratedMessageCompanion[GetViewsRequest]
- object GetViewsResponse extends GeneratedMessageCompanion[GetViewsResponse]
- object GetWorkflowExecutionRequest extends GeneratedMessageCompanion[GetWorkflowExecutionRequest]
- object GrpcEndpoint extends GeneratedMessageCompanion[GrpcEndpoint]
- object HttpEndpoint extends GeneratedMessageCompanion[HttpEndpoint]
- object MessageDestination extends GeneratedMessageCompanion[MessageDestination]
- object MessageSource extends GeneratedMessageCompanion[MessageSource]
- object PrincipalMatcher extends GeneratedMessageCompanion[PrincipalMatcher]
- object RegisteredTimer extends GeneratedMessageCompanion[RegisteredTimer]
- object StatefulComponentState extends GeneratedMessageCompanion[StatefulComponentState]
- object Stream extends GeneratedMessageCompanion[Stream]
- object Topic extends GeneratedMessageCompanion[Topic]
- object View extends GeneratedMessageCompanion[View]
- object ViewDefinition extends GeneratedMessageCompanion[ViewDefinition]
- 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]