@mochabug/adapt-web 0.0.1-beta

package/dist/genproto/mochabugapis/adapt/runtime/v1/store_pb.d.ts

@@ -0,0 +1,530 @@
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
+import type { Timestamp, Value } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file mochabugapis/adapt/runtime/v1/store.proto.
+ */
+export declare const file_mochabugapis_adapt_runtime_v1_store: GenFile;
+/**
+ * Represents the data to be stored, along with its TTL
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.PutValue
+ */
+export type PutValue = Message<"mochabugapis.adapt.runtime.v1.PutValue"> & {
+    /**
+     * The actual value (can be anything, even not even set)
+     *
+     * @generated from field: google.protobuf.Value value = 1;
+     */
+    value?: Value;
+    /**
+     * Time-to-live in seconds. If zero or negative, no expiration
+     *
+     * @generated from field: int32 ttl = 2;
+     */
+    ttl: number;
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.PutValue.
+ * Use `create(PutValueSchema)` to create a new message.
+ */
+export declare const PutValueSchema: GenMessage<PutValue>;
+/**
+ * Represents the data to be stored, along with its TTL
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.GetValue
+ */
+export type GetValue = Message<"mochabugapis.adapt.runtime.v1.GetValue"> & {
+    /**
+     * The actual value
+     *
+     * @generated from field: google.protobuf.Value value = 1;
+     */
+    value?: Value;
+    /**
+     * Time-to-live in seconds. If zero or negative, no expiration
+     *
+     * @generated from field: int32 ttl = 2;
+     */
+    ttl: number;
+    /**
+     * The timestamp when the value was last modified
+     *
+     * @generated from field: google.protobuf.Timestamp last_modified = 3;
+     */
+    lastModified?: Timestamp;
+    /**
+     * The corresponding etag of the value
+     *
+     * @generated from field: string etag = 4;
+     */
+    etag: string;
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.GetValue.
+ * Use `create(GetValueSchema)` to create a new message.
+ */
+export declare const GetValueSchema: GenMessage<GetValue>;
+/**
+ * Ensures the last_modified timestamp is compared based on the operator
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.TimestampCondition
+ */
+export type TimestampCondition = Message<"mochabugapis.adapt.runtime.v1.TimestampCondition"> & {
+    /**
+     * The comparison operator for the timestamp
+     *
+     * @generated from field: mochabugapis.adapt.runtime.v1.Operator operator = 1;
+     */
+    operator: Operator;
+    /**
+     * The timestamp to compare against
+     *
+     * @generated from field: google.protobuf.Timestamp timestamp = 2;
+     */
+    timestamp?: Timestamp;
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.TimestampCondition.
+ * Use `create(TimestampConditionSchema)` to create a new message.
+ */
+export declare const TimestampConditionSchema: GenMessage<TimestampCondition>;
+/**
+ * Ensures the etag is compared based on the specified operator
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.EtagCondition
+ */
+export type EtagCondition = Message<"mochabugapis.adapt.runtime.v1.EtagCondition"> & {
+    /**
+     * The comparison operator for the etag
+     *
+     * @generated from field: mochabugapis.adapt.runtime.v1.Operator operator = 1;
+     */
+    operator: Operator;
+    /**
+     * The etag to compare against
+     *
+     * @generated from field: string etag = 2;
+     */
+    etag: string;
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.EtagCondition.
+ * Use `create(EtagConditionSchema)` to create a new message.
+ */
+export declare const EtagConditionSchema: GenMessage<EtagCondition>;
+/**
+ * Represents preconditions for write operations on a value
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.Precondition
+ */
+export type Precondition = Message<"mochabugapis.adapt.runtime.v1.Precondition"> & {
+    /**
+     * Specifies whether the key should exist (true) or not (false)
+     *
+     * @generated from field: optional bool exists = 1;
+     */
+    exists?: boolean;
+    /**
+     * Specifies the conditions for the last modified timestamp of the value (cannot be used for insert operations!)
+     *
+     * @generated from field: repeated mochabugapis.adapt.runtime.v1.TimestampCondition last_modified = 2;
+     */
+    lastModified: TimestampCondition[];
+    /**
+     * Specifies the conditions for the etag of the value (cannot be used for insert operations!)
+     *
+     * @generated from field: optional mochabugapis.adapt.runtime.v1.EtagCondition etag = 3;
+     */
+    etag?: EtagCondition;
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.Precondition.
+ * Use `create(PreconditionSchema)` to create a new message.
+ */
+export declare const PreconditionSchema: GenMessage<Precondition>;
+/**
+ * Operation to update a key-value pair.
+ * Outcomes:
+ * If the key already exists, and `fail_if_exists` is true: Status is BAD_REQUEST (HTTP 400)
+ * If the precondition has failed: Status is PRECONDITION_FAILED (HTTP 412)
+ * If the key already exists, and `fail_if_exists` is false or not set: Status is OK (HTTP 200)
+ * If there's any internal server error: Status is INTERNAL_SERVER_ERROR (HTTP 500)
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.UpdateOp
+ */
+export type UpdateOp = Message<"mochabugapis.adapt.runtime.v1.UpdateOp"> & {
+    /**
+     * The key to be inserted/updated
+     *
+     * @generated from field: string key = 1;
+     */
+    key: string;
+    /**
+     * Data to be stored
+     *
+     * @generated from field: mochabugapis.adapt.runtime.v1.PutValue value = 2;
+     */
+    value?: PutValue;
+    /**
+     * The precondition of the operation
+     *
+     * @generated from field: mochabugapis.adapt.runtime.v1.Precondition precondition = 3;
+     */
+    precondition?: Precondition;
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.UpdateOp.
+ * Use `create(UpdateOpSchema)` to create a new message.
+ */
+export declare const UpdateOpSchema: GenMessage<UpdateOp>;
+/**
+ * Operation to insert
+ * Outcomes:
+ * If the key already exists, and `fail_if_exists` is true: Status is BAD_REQUEST (HTTP 400)
+ * If the precondition has failed: Status is PRECONDITION_FAILED (HTTP 412)
+ * If the key already exists, and `fail_if_exists` is false or not set: Status is OK (HTTP 200)
+ * If there's any internal server error: Status is INTERNAL_SERVER_ERROR (HTTP 500)
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.InsertOp
+ */
+export type InsertOp = Message<"mochabugapis.adapt.runtime.v1.InsertOp"> & {
+    /**
+     * The key to be inserted/updated
+     *
+     * @generated from field: string key = 1;
+     */
+    key: string;
+    /**
+     * Data to be stored
+     *
+     * @generated from field: mochabugapis.adapt.runtime.v1.PutValue value = 2;
+     */
+    value?: PutValue;
+    /**
+     * The precondition of the operation
+     *
+     * @generated from field: mochabugapis.adapt.runtime.v1.Precondition precondition = 3;
+     */
+    precondition?: Precondition;
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.InsertOp.
+ * Use `create(InsertOpSchema)` to create a new message.
+ */
+export declare const InsertOpSchema: GenMessage<InsertOp>;
+/**
+ * Operation to retrieve the value of a given key.
+ * Outcomes:
+ * If the key exists and data is successfully fetched: Status is OK (HTTP 200)
+ * If the key does not exist: Status is NOT_FOUND (HTTP 404)
+ * If there's any internal server error: Status is INTERNAL_SERVER_ERROR (HTTP 500)
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.GetOp
+ */
+export type GetOp = Message<"mochabugapis.adapt.runtime.v1.GetOp"> & {
+    /**
+     * The key to be fetched
+     *
+     * @generated from field: string key = 1;
+     */
+    key: string;
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.GetOp.
+ * Use `create(GetOpSchema)` to create a new message.
+ */
+export declare const GetOpSchema: GenMessage<GetOp>;
+/**
+ * Operation to delete a given key-value pair.
+ * Outcomes:
+ * If the key exists and is successfully deleted: Status is NO_CONTENT (HTTP 204)
+ * If the precondition has failed: Status is PRECONDITION_FAILED (HTTP 412)
+ * If the key does not exist (treated as no-op or an error, based on design): Status is NOT_FOUND (HTTP 404) or NO_CONTENT (HTTP 204)
+ * If there's any internal server error: Status is INTERNAL_SERVER_ERROR (HTTP 500)
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.DeleteOp
+ */
+export type DeleteOp = Message<"mochabugapis.adapt.runtime.v1.DeleteOp"> & {
+    /**
+     * The key to be deleted
+     *
+     * @generated from field: string key = 1;
+     */
+    key: string;
+    /**
+     * The precondition of the operation
+     *
+     * @generated from field: mochabugapis.adapt.runtime.v1.Precondition precondition = 2;
+     */
+    precondition?: Precondition;
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.DeleteOp.
+ * Use `create(DeleteOpSchema)` to create a new message.
+ */
+export declare const DeleteOpSchema: GenMessage<DeleteOp>;
+/**
+ * WriteOperation represents a single operation to be performed on the key-value store.
+ * An operation can be of type PutOp, GetOp, or DeleteOp.
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.WriteOperation
+ */
+export type WriteOperation = Message<"mochabugapis.adapt.runtime.v1.WriteOperation"> & {
+    /**
+     * `operation` is a oneof field that specifies the type and details of the operation to be performed.
+     * Only one of these fields should be set.
+     *
+     * @generated from oneof mochabugapis.adapt.runtime.v1.WriteOperation.operation
+     */
+    operation: {
+        /**
+         * `insert_op` represents an operation to insert or update a key-value pair in the store.
+         * If this is set, the service will attempt to put the given value associated with the specified key.
+         *
+         * @generated from field: mochabugapis.adapt.runtime.v1.InsertOp insert_op = 1;
+         */
+        value: InsertOp;
+        case: "insertOp";
+    } | {
+        /**
+         * `update_op` represents an operation to insert or update a key-value pair in the store.
+         * If this is set, the service will attempt to put the given value associated with the specified key.
+         *
+         * @generated from field: mochabugapis.adapt.runtime.v1.UpdateOp update_op = 2;
+         */
+        value: UpdateOp;
+        case: "updateOp";
+    } | {
+        /**
+         * `delete_op` represents an operation to delete a key-value pair from the store using the specified key.
+         * If this is set, the service will attempt to delete the entry associated with the given key.
+         *
+         * @generated from field: mochabugapis.adapt.runtime.v1.DeleteOp delete_op = 3;
+         */
+        value: DeleteOp;
+        case: "deleteOp";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.WriteOperation.
+ * Use `create(WriteOperationSchema)` to create a new message.
+ */
+export declare const WriteOperationSchema: GenMessage<WriteOperation>;
+/**
+ * ReadOperationResult encapsulates the outcome of a specific read operation performed on the key-value store.
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.ReadOperationResult
+ */
+export type ReadOperationResult = Message<"mochabugapis.adapt.runtime.v1.ReadOperationResult"> & {
+    /**
+     * `key` represents the specific key targeted by the operation in the key-value store.
+     * It provides context to the client about which key this particular result pertains to.
+     *
+     * @generated from field: string key = 1;
+     */
+    key: string;
+    /**
+     * `status` indicates the outcome of the operation performed on the key.
+     * This status can be used by the client to quickly understand if the operation
+     * was successful or encountered an error, and what kind of error if so.
+     *
+     * @generated from field: mochabugapis.adapt.runtime.v1.OperationStatus status = 2;
+     */
+    status: OperationStatus;
+    /**
+     * `response` is a oneof field that provides more specific details about the result of the operation.
+     * Depending on the operation type and its outcome, the value is set or not
+     *
+     * @generated from field: optional mochabugapis.adapt.runtime.v1.GetValue response = 3;
+     */
+    response?: GetValue;
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.ReadOperationResult.
+ * Use `create(ReadOperationResultSchema)` to create a new message.
+ */
+export declare const ReadOperationResultSchema: GenMessage<ReadOperationResult>;
+/**
+ * WriteOperationResult encapsulates the outcome of a specific write operation performed on the key-value store
+ *
+ * @generated from message mochabugapis.adapt.runtime.v1.WriteOperationResult
+ */
+export type WriteOperationResult = Message<"mochabugapis.adapt.runtime.v1.WriteOperationResult"> & {
+    /**
+     * `key` represents the specific key targeted by the operation in the key-value store.
+     * It provides context to the client about which key this particular result pertains to.
+     *
+     * @generated from field: string key = 1;
+     */
+    key: string;
+    /**
+     * `status` indicates the outcome of the operation performed on the key.
+     * This status can be used by the client to quickly understand if the operation
+     * was successful or encountered an error, and what kind of error if so.
+     *
+     * @generated from field: mochabugapis.adapt.runtime.v1.OperationStatus status = 2;
+     */
+    status: OperationStatus;
+    /**
+     * The timestamp when the value was written
+     *
+     * @generated from field: google.protobuf.Timestamp last_modified = 3;
+     */
+    lastModified?: Timestamp;
+    /**
+     * The corresponding etag of the value
+     *
+     * @generated from field: string etag = 4;
+     */
+    etag: string;
+};
+/**
+ * Describes the message mochabugapis.adapt.runtime.v1.WriteOperationResult.
+ * Use `create(WriteOperationResultSchema)` to create a new message.
+ */
+export declare const WriteOperationResultSchema: GenMessage<WriteOperationResult>;
+/**
+ * Operators for comparison
+ *
+ * @generated from enum mochabugapis.adapt.runtime.v1.Operator
+ */
+export declare enum Operator {
+    /**
+     * Default value that should never be used.
+     *
+     * @generated from enum value: OPERATOR_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Equal to
+     *
+     * @generated from enum value: OPERATOR_EQUAL = 1;
+     */
+    EQUAL = 1,
+    /**
+     * Greater than
+     *
+     * @generated from enum value: OPERATOR_GREATER_THAN = 2;
+     */
+    GREATER_THAN = 2,
+    /**
+     * Greater than or equal to
+     *
+     * @generated from enum value: OPERATOR_GREATER_THAN_OR_EQUAL = 3;
+     */
+    GREATER_THAN_OR_EQUAL = 3,
+    /**
+     * Less than
+     *
+     * @generated from enum value: OPERATOR_LESS_THAN = 4;
+     */
+    LESS_THAN = 4,
+    /**
+     * Less than or equal to
+     *
+     * @generated from enum value: OPERATOR_LESS_THAN_OR_EQUAL = 5;
+     */
+    LESS_THAN_OR_EQUAL = 5,
+    /**
+     * Not equal to
+     *
+     * @generated from enum value: OPERATOR_NOT_EQUAL = 6;
+     */
+    NOT_EQUAL = 6
+}
+/**
+ * Describes the enum mochabugapis.adapt.runtime.v1.Operator.
+ */
+export declare const OperatorSchema: GenEnum<Operator>;
+/**
+ * GlobalResponseStatus represents the overall status of a batch operation.
+ *
+ * @generated from enum mochabugapis.adapt.runtime.v1.GlobalResponseStatus
+ */
+export declare enum GlobalResponseStatus {
+    /**
+     * Default value that should never be used.
+     *
+     * @generated from enum value: GLOBAL_RESPONSE_STATUS_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * 200 OK: All operations succeeded
+     *
+     * @generated from enum value: GLOBAL_RESPONSE_STATUS_SUCCESS = 1;
+     */
+    SUCCESS = 1,
+    /**
+     * 206 Partial Content: Some operations succeeded
+     *
+     * @generated from enum value: GLOBAL_RESPONSE_STATUS_PARTIAL_SUCCESS = 2;
+     */
+    PARTIAL_SUCCESS = 2,
+    /**
+     * 400 Bad Request: All operations failed
+     *
+     * @generated from enum value: GLOBAL_RESPONSE_STATUS_FAILED = 3;
+     */
+    FAILED = 3,
+    /**
+     * 500 Internal Server Error: System error
+     *
+     * @generated from enum value: GLOBAL_RESPONSE_STATUS_INTERNAL_ERROR = 4;
+     */
+    INTERNAL_ERROR = 4
+}
+/**
+ * Describes the enum mochabugapis.adapt.runtime.v1.GlobalResponseStatus.
+ */
+export declare const GlobalResponseStatusSchema: GenEnum<GlobalResponseStatus>;
+/**
+ * OperationStatus represents the status of individual operations in a batch.
+ *
+ * @generated from enum mochabugapis.adapt.runtime.v1.OperationStatus
+ */
+export declare enum OperationStatus {
+    /**
+     * Default value that should never be used.
+     *
+     * @generated from enum value: OPERATION_STATUS_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * 200 OK
+     *
+     * @generated from enum value: OPERATION_STATUS_OK = 1;
+     */
+    OK = 1,
+    /**
+     * 400 Bad Request
+     *
+     * @generated from enum value: OPERATION_STATUS_BAD_REQUEST = 2;
+     */
+    BAD_REQUEST = 2,
+    /**
+     * 404 Not Found
+     *
+     * @generated from enum value: OPERATION_STATUS_NOT_FOUND = 3;
+     */
+    NOT_FOUND = 3,
+    /**
+     * 412 Precondition Failed
+     *
+     * @generated from enum value: OPERATION_STATUS_PRECONDITION_FAILED = 4;
+     */
+    PRECONDITION_FAILED = 4,
+    /**
+     * 500 Internal Server Error
+     *
+     * @generated from enum value: OPERATION_STATUS_INTERNAL_SERVER_ERROR = 5;
+     */
+    INTERNAL_SERVER_ERROR = 5
+}
+/**
+ * Describes the enum mochabugapis.adapt.runtime.v1.OperationStatus.
+ */
+export declare const OperationStatusSchema: GenEnum<OperationStatus>;