@spine-event-engine/proto 2.0.0-snapshot.10

package/proto/spine/client/entities.proto

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2026, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+syntax = "proto3";
+
+package spine.client;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_multiple_files = true;
+option java_outer_classname = "EntitiesProto";
+option java_package = "io.spine.client";
+
+import "google/protobuf/any.proto";
+
+// Represents an ID of an entity.
+//
+// Acts as a read-side API identifier for Projection state, Aggregate state and other entities.
+//
+message EntityId {
+
+    // An ID of an entity.
+    google.protobuf.Any id = 1;
+}

package/proto/spine/client/filters.proto

@@ -0,0 +1,170 @@
+/*
+ * Copyright 2026, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+syntax = "proto3";
+
+package spine.client;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_multiple_files = true;
+option java_outer_classname = "FiltersProto";
+option java_package = "io.spine.client";
+
+import "google/protobuf/any.proto";
+
+import "spine/base/field_path.proto";
+
+// Defines the target type and filters.
+//
+// Use `Target` to specify and narrow down the source for `Topic` and `Query` by
+// the target type and various criteria.
+//
+message Target {
+    option (is).java_type = "TargetMixin";
+
+    // The type of the entity or event of interest.
+    //
+    // Queries support only entity targets while subscriptions work with both event and
+    // entity state types.
+    //
+    string type = 1 [(required) = true];
+
+    // The filters that are applied to the received entity state or event message.
+    oneof criterion {
+        // Either `include_all` must be set to `true`, or `filters` must be specified.
+        option (choice).required = true;
+
+        // The instruction to include all objects of a given type.
+        bool include_all = 2;
+
+        // Filter the objects by a certain criterion.
+        //
+        // Filters must not be empty unless `include_all` is set.
+        //
+        TargetFilters filters = 3 [(validate) = true];
+    }
+}
+
+// The set of filters to narrow down the query results/subscription updates.
+message TargetFilters {
+    option (required_field) = "id_filter|filter";
+
+    // Match objects by their IDs.
+    IdFilter id_filter = 1 [(validate) = true];
+
+    // Match objects by the values of their fields.
+    repeated CompositeFilter filter = 2 [(validate) = true];
+}
+
+// A filter grouping a sub-tree of filters with a specified logical operator.
+//
+// May contain both simple filters (i.e. those aimed to match a single field value of the
+// target object) and composite filters.
+//
+// If an instance of `CompositeFilter` has no children, any target object is considered matching.
+message CompositeFilter {
+    option (is).java_type = "CompositeFilterMixin";
+
+    // The list of simple filters.
+    repeated Filter filter = 1 [(validate) = true];
+
+    // The value of the composite operator that determines the behavior of the filter matching.
+    CompositeOperator operator = 2 [(required) = true];
+
+    // The list of child composite filters.
+    repeated CompositeFilter composite_filter = 3 [(validate) = true];;
+
+    // An enumeration of all supported composite operators upon the filters.
+    enum CompositeOperator {
+
+        // Error value.
+        CCF_CO_UNDEFINED = 0;
+
+        // The conjunctive operator. The SQL equivalent is `AND`.
+        ALL = 1;
+
+        // The disjunctive operator. The SQL equivalent is `OR`.
+        EITHER = 2;
+    }
+}
+
+// A simple filter matching some value in the event message/entity state.
+message Filter {
+    option (is).java_type = "FilterMixin";
+
+    // The path to the field to be matched.
+    //
+    // If the filter is an entity query filter, this path must contain a top-level message field
+    // marked with the `(column)` option.
+    //
+    // For subscriptions, any message fields can be specified including the nested fields.
+    //
+    base.FieldPath field_path = 1 [(required) = true];
+
+    // The value to compare upon.
+    google.protobuf.Any value = 2 [(required) = true];
+
+    // The comparison operator.
+    Operator operator = 3 [(required) = true];
+
+    // An enumeration of all supported comparison operators.
+    enum Operator {
+
+        // Error value.
+        CFO_UNDEFINED = 0;
+
+        // The stored value is equal (`=`) to the passed value.
+        EQUAL = 1;
+
+        // The stored value is greater than (`>`) the passed value.
+        GREATER_THAN = 2;
+
+        // The stored value is less than (`<`) the passed value.
+        LESS_THAN = 4;
+
+        // The stored value is greater than or equal to (`>=`) the passed value.
+        GREATER_OR_EQUAL = 5;
+
+        // The stored value is less than or equal to (`<=`) the passed value.
+        LESS_OR_EQUAL = 6;
+    }
+}
+
+// Allows adding an ID filter for the read operations.
+//
+// Used to filter out all objects with identifiers not included in the filter.
+// SQL equivalent is "... where row.id IN (...)".
+//
+message IdFilter {
+
+    // The collection of IDs.
+    //
+    // Must not be empty.
+    //
+    repeated google.protobuf.Any id = 1 [(required) = true, (validate) = true];
+}

package/proto/spine/client/query.proto

@@ -0,0 +1,186 @@
+/*
+ * Copyright 2026, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+syntax = "proto3";
+
+package spine.client;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_multiple_files = true;
+option java_outer_classname = "QueryProto";
+option java_package = "io.spine.client";
+
+import "google/protobuf/any.proto";
+import "google/protobuf/field_mask.proto";
+
+import "spine/core/user_id.proto";
+import "spine/core/actor_context.proto";
+import "spine/core/response.proto";
+import "spine/client/filters.proto";
+import "spine/core/version.proto";
+
+// Query identifier.
+//
+message QueryId {
+
+    // The value of the ID.
+    //
+    // Starts with the `q-` prefix followed by a generated UUID value.
+    //
+    string value = 1;
+}
+
+// An order for query results.
+//
+message OrderBy {
+    
+    // A direction of sorting for ordering the Query results.
+    Direction direction = 1 [(required) = true];
+
+    // A column name whose value is used for ordering the query results. 
+    string column = 2 [(required) = true];
+    
+    // A direction of an `OrderBy` clause specifying if greater or lesser values should come first.
+    enum Direction {
+        
+        // Reserved default value.
+        OD_UNKNOWN = 0;
+        
+        // An order in which every following value is greater than the previous one.
+        //
+        // For example, collections sorted in an ascending order are `[1, 2, 3]` and 
+        // `["2 cherries", "apple", "apricot", "orange"]`.
+        //
+        // The missing values are placed at the beginning of a collection in an ascending order:
+        // `[null, -2211760924, 0, 943912800]`.
+        //
+        ASCENDING = 1;
+
+        // An order in which every following value is lesser than the previous one.
+        //
+        // For example, collections sorted in a descending order are `[2033, 2001, 1984]` and 
+        // `['NaCl', 'N2O', 'H2O2', 'H2O', 'C12H22O11']`.
+        //
+        // The missing values are placed at the end of a collection in a descending order:
+        // `[1905, 1687, -280, null]`.
+        //
+        DESCENDING = 2;
+    }
+}
+
+// Allows clients to form the requests to the read-side through the `QueryService`.
+//
+// `Query` execution typically results in a `QueryResponse` object.
+//
+message Query {
+
+    option (is).java_type = "QueryMixin";
+
+    // The ID of the query.
+    QueryId id = 1 [(required) = true];
+
+    // Defines the entity of interest, e.g. entity type URL and a set of fetch criteria.
+    Target target = 2 [(required) = true, (validate) = true];
+
+    // Service information about the environment in which the query was created.
+    core.ActorContext context = 3 [(required) = true, (validate) = true];
+
+    ResponseFormat format = 4 [(validate) = true];
+}
+
+// A `Query` response format.
+//
+// Includes which data should be retrieved, the ordering, and pagination.
+//
+message ResponseFormat {
+
+    // Field mask to be applied to the items of the query result.
+    google.protobuf.FieldMask field_mask = 1;
+
+    // An order for entities returned by the Query.
+    //
+    // In case there are several ordering directives, they are applied one-by-one, each following
+    // dealing only with the records considered equal by the previous directive.
+    //
+    // I.e. the first directive is applied to the original set of responses, then the second
+    // directive is used to judge on the order of the records considered to have the same index
+    // of order by the first directive. Same behaviour is expected for each N-th and (N+1)-th of
+    // ordering directives.
+    //
+    repeated OrderBy order_by = 2 [(validate) = true];
+
+    // The max number of entities to retrieve.
+    //
+    // If greater than 0, `order_by` should be set as well.
+    //
+    uint32 limit = 3;
+}
+
+// The result of `Query` processing.
+//
+// Contains the actual processing results and other response attributes.
+// Used as a result of `QueryService.Read(Query)` gRPC method call.
+//
+message QueryResponse {
+    option (is).java_type = "QueryResponseMixin";
+
+    // The base status part of the query processing response.
+    //
+    // For example: whether the `Query` has been acked or not.
+    //
+    core.Response response = 1 [(required) = true];
+
+    // Entity states and versions returned to the API user as a result of Query execution.
+    repeated EntityStateWithVersion message = 2;
+}
+
+// Represents the entity state combined with entity version.
+//
+// This message is a part of Query response.
+//
+message EntityStateWithVersion {
+
+    // The state of the entity packed as `Any`.
+    google.protobuf.Any state = 1;
+
+    // The version of the entity.
+    core.Version version = 2;
+}
+
+// Enumeration of possible technical error reasons occurring in query validation.
+enum QueryValidationError {
+
+    // Reserved value.
+    QVE_UNKNOWN_REASON = 0;
+
+    // The query target is not supported by the server.
+    UNSUPPORTED_QUERY_TARGET = 1;
+
+    // The query message is invalid according to custom Protobuf options set.
+    INVALID_QUERY = 2;
+}

package/proto/spine/client/query_service.proto

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2026, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+syntax = "proto3";
+
+package spine.client;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_package = "io.spine.client.grpc";
+option java_multiple_files = true;
+option java_outer_classname = "QueryServiceProto";
+
+import "spine/client/query.proto";
+import "google/protobuf/type.proto";
+
+// A service for querying the read-side from clients.
+service QueryService {
+
+    // Reads certain data from the read-side by setting the criteria via Query.
+    rpc Read(Query) returns (QueryResponse);
+}

package/proto/spine/client/subscription.proto

@@ -0,0 +1,220 @@
+/*
+ * Copyright 2026, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+syntax = "proto3";
+
+package spine.client;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.spine.io";
+option java_package = "io.spine.client";
+option java_multiple_files = true;
+option java_outer_classname = "SubscriptionProto";
+
+import "google/protobuf/any.proto";
+import "google/protobuf/field_mask.proto";
+
+import "spine/core/user_id.proto";
+import "spine/core/tenant_id.proto";
+import "spine/core/actor_context.proto";
+import "spine/core/event.proto";
+import "spine/core/response.proto";
+import "spine/client/filters.proto";
+
+// Topic identifier.
+message TopicId {
+
+    // The value of the ID.
+    //
+    // Starts with the `t-` prefix followed by a generated UUID value.
+    //
+    string value = 1;
+}
+
+// An object defining a unit of subscription.
+//
+// Defines the target (type and criteria) of subscription.
+//
+message Topic {
+
+    TopicId id = 1 [(required) = true];
+
+    // Defines the target of interest, e.g. event/entity type URL and a set of subscription
+    // criteria.
+    Target target = 2 [(required) = true, (validate) = true];
+
+    // Field mask to be applied to the subscription updates.
+    google.protobuf.FieldMask field_mask = 3;
+
+    // Service information about the environment in which the topic was created.
+    core.ActorContext context = 4 [(required) = true, (validate) = true];
+}
+
+// Wrapped collection of read-side entity updates on a topic with the specific subscription ID.
+message SubscriptionUpdate {
+    option (is).java_type = "SubscriptionUpdateMixin";
+
+    // The subscription in whose scope this update is propagated.
+    Subscription subscription = 1 [(required) = true];
+
+    // Represents the base part of the response,
+    // i.e. whether the Topic subscription has been acked or not.
+    core.Response response = 2 [(required) = true];
+
+    // Reserved for more subscription update attributes.
+    reserved 3 to 9;
+
+    // Deleted field `updates`.
+    //
+    // Use the new `update` field instead.
+    //
+    reserved 10;
+
+    // Deleted field `entity_state_updates`.
+    //
+    // Use the new `update` field instead.
+    //
+    reserved 11;
+
+    // Each subscription update delivers either entity state updates or events that occurred in the
+    // system.
+    oneof update {
+
+        // The entity state updates if it's an entity subscription.
+        EntityUpdates entity_updates = 12;
+
+        // The new events that occurred in the system if it's an event subscription.
+        EventUpdates event_updates = 13;
+    }
+}
+
+// The updates on the observed entity state.
+message EntityUpdates {
+
+    // The entity state update list.
+    repeated EntityStateUpdate update = 1 [(validate) = true];
+}
+
+// The update happened to the entity of interest.
+message EntityStateUpdate {
+
+    // The entity ID packed as Any.
+    google.protobuf.Any id = 1 [(required) = true];
+
+    // The update may be one of two things.
+    oneof kind {
+
+        // The state of the entity has been updated and packed here as `Any`.
+        //
+        // If the field mask is set in `Topic`, this value is masked.
+        //
+        google.protobuf.Any state = 2;
+
+        // The state of the entity has been changed, so that previously it matched the subscription
+        // `Target` filters, and now it does not.
+        //
+        // For example, consider a subscription to all `UserSession`s in which a user has sent
+        // at most `N` requests:
+        // ```
+        // WHERE REQUEST_COUNT <= N
+        // ```
+        //
+        // Suppose a `UserSession` with ID 42 matches the subscription. After some time, the user
+        // makes their N + 1-th request and the `UserSession` with ID 42 stops matching
+        // the subscription. Hence, the next update brings the `no_longer_matching` option instead
+        // of an entity state.
+        //
+        bool no_longer_matching = 3;
+    }
+}
+
+// The new events of the observed type that occurred in the system.
+message EventUpdates {
+
+    // The event list.
+    repeated core.Event event = 1 [(validate) = true];
+}
+
+// Subscription identifier.
+message SubscriptionId {
+
+    // The value of the subscription ID.
+    //
+    // Starts with the `s-` prefix followed by a generated UUID value.
+    //
+    string value = 1;
+}
+
+// The subscription object.
+//
+// Created when the client subscribes to a topic inside the read-side implementation.
+// Generally should not be created directly in the client code.
+//
+// See SubscriptionService#Subscribe(Topic).
+//
+message Subscription {
+
+    option (is).java_type = "SubscriptionMixin";
+
+    // Unique identifier of the subscription.
+    //
+    // Must be unique in the scope of a bounded context.
+    //
+    SubscriptionId id = 1 [(required) = true];
+
+    // Represents the original topic for this subscription.
+    Topic topic = 2 [(required) = true, (validate) = true];
+}
+
+// Enumeration of possible technical error reasons occurring in topic validation.
+enum TopicValidationError {
+
+    // Reserved value.
+    TVE_UNKNOWN_REASON = 0;
+
+    // The topic target is not supported by the server.
+    UNSUPPORTED_TOPIC_TARGET = 1;
+
+    // The topic message is invalid according to custom Protobuf options set.
+    INVALID_TOPIC = 2;
+}
+
+// Enumeration of possible technical error reasons occurring in subscription validation.
+enum SubscriptionValidationError {
+
+    // Reserved value.
+    SVE_UNKNOWN_REASON = 0;
+
+    // The target of the subscription topic is not supported by the server.
+    UNSUPPORTED_SUBSCRIPTION_TARGET = 1;
+
+    // The subscription message is invalid according to custom Protobuf options set.
+    INVALID_SUBSCRIPTION = 2;
+
+    // This subscription is unknown to this server.
+    UNKNOWN_SUBSCRIPTION = 3;
+}