@mochabug/adapt-plugin-toolkit
Version:
The API toolkit to facilitate mochabug adapt plugin development
1,421 lines • 96.1 kB
TypeScript
import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
import type { FieldMask, FieldMaskJson, Timestamp, TimestampJson, Value, ValueJson } from "@bufbuild/protobuf/wkt";
import type { Status, StatusJson } from "../../automations/v1/automations_pb";
import type { SignalData, SignalDataJson } from "../../graph/signal_data_pb";
import type { SignalFormat, SignalFormatJson } from "../../graph/signal_format_pb";
import type { Transmitter, TransmitterJson } from "../../graph/transmitter_pb";
import type { VertexMetadata, VertexMetadataJson } from "../../graph/vertex_metadata_pb";
import type { ConditionalWriteOperation, ConditionalWriteOperationJson, GetValue, GetValueJson, SelectOp, SelectOpJson, ValueMetadata, ValueMetadataJson, WriteOperation, WriteOperationJson } from "./store_pb";
import type { Message } from "@bufbuild/protobuf";
/**
* Describes the file mochabugapis/adapt/runtime/v1/runtime.proto.
*/
export declare const file_mochabugapis_adapt_runtime_v1_runtime: GenFile;
/**
* The request to apply operations to the execution store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchWriteStoreRequest
*/
export type ExecutorServiceBatchWriteStoreRequest = Message<"mochabugapis.adapt.runtime.v1.ExecutorServiceBatchWriteStoreRequest"> & {
/**
* A batch of operations to perform in the executor store.
* Refer to the comments on the `Namespace` enum for details on scope requirements.
*
* @generated from field: repeated mochabugapis.adapt.runtime.v1.WriteOperation operations = 1;
*/
operations: WriteOperation[];
/**
* The namespace whee the batch is applied.
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace: Namespace;
};
/**
* The request to apply operations to the execution store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchWriteStoreRequest
*/
export type ExecutorServiceBatchWriteStoreRequestJson = {
/**
* A batch of operations to perform in the executor store.
* Refer to the comments on the `Namespace` enum for details on scope requirements.
*
* @generated from field: repeated mochabugapis.adapt.runtime.v1.WriteOperation operations = 1;
*/
operations?: WriteOperationJson[];
/**
* The namespace whee the batch is applied.
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace?: NamespaceJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchWriteStoreRequest.
* Use `create(ExecutorServiceBatchWriteStoreRequestSchema)` to create a new message.
*/
export declare const ExecutorServiceBatchWriteStoreRequestSchema: GenMessage<ExecutorServiceBatchWriteStoreRequest, {
jsonType: ExecutorServiceBatchWriteStoreRequestJson;
}>;
/**
* The response of the batch store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchWriteStoreResponse
*/
export type ExecutorServiceBatchWriteStoreResponse = Message<"mochabugapis.adapt.runtime.v1.ExecutorServiceBatchWriteStoreResponse"> & {
/**
* Metadata for each written key.
* Note: Metadata is only returned for insert operations, not for delete operations.
*
* @generated from field: map<string, mochabugapis.adapt.runtime.v1.ValueMetadata> metadata = 1;
*/
metadata: {
[key: string]: ValueMetadata;
};
};
/**
* The response of the batch store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchWriteStoreResponse
*/
export type ExecutorServiceBatchWriteStoreResponseJson = {
/**
* Metadata for each written key.
* Note: Metadata is only returned for insert operations, not for delete operations.
*
* @generated from field: map<string, mochabugapis.adapt.runtime.v1.ValueMetadata> metadata = 1;
*/
metadata?: {
[key: string]: ValueMetadataJson;
};
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchWriteStoreResponse.
* Use `create(ExecutorServiceBatchWriteStoreResponseSchema)` to create a new message.
*/
export declare const ExecutorServiceBatchWriteStoreResponseSchema: GenMessage<ExecutorServiceBatchWriteStoreResponse, {
jsonType: ExecutorServiceBatchWriteStoreResponseJson;
}>;
/**
* The write store request
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceWriteStoreRequest
*/
export type ExecutorServiceWriteStoreRequest = Message<"mochabugapis.adapt.runtime.v1.ExecutorServiceWriteStoreRequest"> & {
/**
* The difference in the single write request is that we support conditional
* write operations here. These are useful for implementing locks etc.
* Conditional write operations behaves strangely inside a batch operation since
* the entire batch becomes conditional and they do not follow timestamps
*
* @generated from field: mochabugapis.adapt.runtime.v1.ConditionalWriteOperation operation = 1;
*/
operation?: ConditionalWriteOperation;
/**
* The namespace where the operation is applied.
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace: Namespace;
};
/**
* The write store request
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceWriteStoreRequest
*/
export type ExecutorServiceWriteStoreRequestJson = {
/**
* The difference in the single write request is that we support conditional
* write operations here. These are useful for implementing locks etc.
* Conditional write operations behaves strangely inside a batch operation since
* the entire batch becomes conditional and they do not follow timestamps
*
* @generated from field: mochabugapis.adapt.runtime.v1.ConditionalWriteOperation operation = 1;
*/
operation?: ConditionalWriteOperationJson;
/**
* The namespace where the operation is applied.
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace?: NamespaceJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExecutorServiceWriteStoreRequest.
* Use `create(ExecutorServiceWriteStoreRequestSchema)` to create a new message.
*/
export declare const ExecutorServiceWriteStoreRequestSchema: GenMessage<ExecutorServiceWriteStoreRequest, {
jsonType: ExecutorServiceWriteStoreRequestJson;
}>;
/**
* The response of the single write store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceWriteStoreResponse
*/
export type ExecutorServiceWriteStoreResponse = Message<"mochabugapis.adapt.runtime.v1.ExecutorServiceWriteStoreResponse"> & {
/**
* Metadata for the written key.
* Note: Metadata is only returned for insert operations, not for delete operations.
*
* @generated from field: optional mochabugapis.adapt.runtime.v1.ValueMetadata metadata = 1;
*/
metadata?: ValueMetadata;
};
/**
* The response of the single write store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceWriteStoreResponse
*/
export type ExecutorServiceWriteStoreResponseJson = {
/**
* Metadata for the written key.
* Note: Metadata is only returned for insert operations, not for delete operations.
*
* @generated from field: optional mochabugapis.adapt.runtime.v1.ValueMetadata metadata = 1;
*/
metadata?: ValueMetadataJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExecutorServiceWriteStoreResponse.
* Use `create(ExecutorServiceWriteStoreResponseSchema)` to create a new message.
*/
export declare const ExecutorServiceWriteStoreResponseSchema: GenMessage<ExecutorServiceWriteStoreResponse, {
jsonType: ExecutorServiceWriteStoreResponseJson;
}>;
/**
* The request to apply operations to the execution store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchReadStoreRequest
*/
export type ExecutorServiceBatchReadStoreRequest = Message<"mochabugapis.adapt.runtime.v1.ExecutorServiceBatchReadStoreRequest"> & {
/**
* Keys to fetch from the executor store
* Refer to the comments on the `Namespace` enum for details on scope requirements
*
* @generated from field: repeated string keys = 1;
*/
keys: string[];
/**
* The namespace whee the batch is applied.
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace: Namespace;
};
/**
* The request to apply operations to the execution store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchReadStoreRequest
*/
export type ExecutorServiceBatchReadStoreRequestJson = {
/**
* Keys to fetch from the executor store
* Refer to the comments on the `Namespace` enum for details on scope requirements
*
* @generated from field: repeated string keys = 1;
*/
keys?: string[];
/**
* The namespace whee the batch is applied.
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace?: NamespaceJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchReadStoreRequest.
* Use `create(ExecutorServiceBatchReadStoreRequestSchema)` to create a new message.
*/
export declare const ExecutorServiceBatchReadStoreRequestSchema: GenMessage<ExecutorServiceBatchReadStoreRequest, {
jsonType: ExecutorServiceBatchReadStoreRequestJson;
}>;
/**
* The response of the batch store, any keys not found are ignored
* i.e. not present in the map
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchReadStoreResponse
*/
export type ExecutorServiceBatchReadStoreResponse = Message<"mochabugapis.adapt.runtime.v1.ExecutorServiceBatchReadStoreResponse"> & {
/**
* Map of key to value
*
* @generated from field: map<string, mochabugapis.adapt.runtime.v1.GetValue> items = 1;
*/
items: {
[key: string]: GetValue;
};
};
/**
* The response of the batch store, any keys not found are ignored
* i.e. not present in the map
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchReadStoreResponse
*/
export type ExecutorServiceBatchReadStoreResponseJson = {
/**
* Map of key to value
*
* @generated from field: map<string, mochabugapis.adapt.runtime.v1.GetValue> items = 1;
*/
items?: {
[key: string]: GetValueJson;
};
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExecutorServiceBatchReadStoreResponse.
* Use `create(ExecutorServiceBatchReadStoreResponseSchema)` to create a new message.
*/
export declare const ExecutorServiceBatchReadStoreResponseSchema: GenMessage<ExecutorServiceBatchReadStoreResponse, {
jsonType: ExecutorServiceBatchReadStoreResponseJson;
}>;
/**
* The request to select from the execution store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceSelectStoreRequest
*/
export type ExecutorServiceSelectStoreRequest = Message<"mochabugapis.adapt.runtime.v1.ExecutorServiceSelectStoreRequest"> & {
/**
* The select operation to perform
*
* @generated from field: mochabugapis.adapt.runtime.v1.SelectOp operation = 1;
*/
operation?: SelectOp;
/**
* The namespace where the operation is applied
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace: Namespace;
};
/**
* The request to select from the execution store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceSelectStoreRequest
*/
export type ExecutorServiceSelectStoreRequestJson = {
/**
* The select operation to perform
*
* @generated from field: mochabugapis.adapt.runtime.v1.SelectOp operation = 1;
*/
operation?: SelectOpJson;
/**
* The namespace where the operation is applied
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace?: NamespaceJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExecutorServiceSelectStoreRequest.
* Use `create(ExecutorServiceSelectStoreRequestSchema)` to create a new message.
*/
export declare const ExecutorServiceSelectStoreRequestSchema: GenMessage<ExecutorServiceSelectStoreRequest, {
jsonType: ExecutorServiceSelectStoreRequestJson;
}>;
/**
* The response of the select store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceSelectStoreResponse
*/
export type ExecutorServiceSelectStoreResponse = Message<"mochabugapis.adapt.runtime.v1.ExecutorServiceSelectStoreResponse"> & {
/**
* Results
*
* @generated from field: map<string, mochabugapis.adapt.runtime.v1.GetValue> items = 1;
*/
items: {
[key: string]: GetValue;
};
/**
* Next page token
*
* @generated from field: optional string next_token = 2;
*/
nextToken?: string;
};
/**
* The response of the select store
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceSelectStoreResponse
*/
export type ExecutorServiceSelectStoreResponseJson = {
/**
* Results
*
* @generated from field: map<string, mochabugapis.adapt.runtime.v1.GetValue> items = 1;
*/
items?: {
[key: string]: GetValueJson;
};
/**
* Next page token
*
* @generated from field: optional string next_token = 2;
*/
nextToken?: string;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExecutorServiceSelectStoreResponse.
* Use `create(ExecutorServiceSelectStoreResponseSchema)` to create a new message.
*/
export declare const ExecutorServiceSelectStoreResponseSchema: GenMessage<ExecutorServiceSelectStoreResponse, {
jsonType: ExecutorServiceSelectStoreResponseJson;
}>;
/**
* A request to cancel a running exchange operation
*
* @generated from message mochabugapis.adapt.runtime.v1.CancelExchangeOperationRequest
*/
export type CancelExchangeOperationRequest = Message<"mochabugapis.adapt.runtime.v1.CancelExchangeOperationRequest"> & {
/**
* The id of the operation
*
* @generated from field: string id = 1;
*/
id: string;
};
/**
* A request to cancel a running exchange operation
*
* @generated from message mochabugapis.adapt.runtime.v1.CancelExchangeOperationRequest
*/
export type CancelExchangeOperationRequestJson = {
/**
* The id of the operation
*
* @generated from field: string id = 1;
*/
id?: string;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.CancelExchangeOperationRequest.
* Use `create(CancelExchangeOperationRequestSchema)` to create a new message.
*/
export declare const CancelExchangeOperationRequestSchema: GenMessage<CancelExchangeOperationRequest, {
jsonType: CancelExchangeOperationRequestJson;
}>;
/**
* The response of cancelling the exchange operation
*
* @generated from message mochabugapis.adapt.runtime.v1.CancelExchangeOperationResponse
*/
export type CancelExchangeOperationResponse = Message<"mochabugapis.adapt.runtime.v1.CancelExchangeOperationResponse"> & {};
/**
* The response of cancelling the exchange operation
*
* @generated from message mochabugapis.adapt.runtime.v1.CancelExchangeOperationResponse
*/
export type CancelExchangeOperationResponseJson = {};
/**
* Describes the message mochabugapis.adapt.runtime.v1.CancelExchangeOperationResponse.
* Use `create(CancelExchangeOperationResponseSchema)` to create a new message.
*/
export declare const CancelExchangeOperationResponseSchema: GenMessage<CancelExchangeOperationResponse, {
jsonType: CancelExchangeOperationResponseJson;
}>;
/**
* A request to check the status of an operation
*
* @generated from message mochabugapis.adapt.runtime.v1.GetExchangeOperationRequest
*/
export type GetExchangeOperationRequest = Message<"mochabugapis.adapt.runtime.v1.GetExchangeOperationRequest"> & {
/**
* The id of the operation
*
* @generated from field: string id = 1;
*/
id: string;
};
/**
* A request to check the status of an operation
*
* @generated from message mochabugapis.adapt.runtime.v1.GetExchangeOperationRequest
*/
export type GetExchangeOperationRequestJson = {
/**
* The id of the operation
*
* @generated from field: string id = 1;
*/
id?: string;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.GetExchangeOperationRequest.
* Use `create(GetExchangeOperationRequestSchema)` to create a new message.
*/
export declare const GetExchangeOperationRequestSchema: GenMessage<GetExchangeOperationRequest, {
jsonType: GetExchangeOperationRequestJson;
}>;
/**
* The get operation response
*
* @generated from message mochabugapis.adapt.runtime.v1.GetExchangeOperationResponse
*/
export type GetExchangeOperationResponse = Message<"mochabugapis.adapt.runtime.v1.GetExchangeOperationResponse"> & {
/**
* The actual operation
*
* @generated from field: mochabugapis.adapt.runtime.v1.ExchangeOperation item = 1;
*/
item?: ExchangeOperation;
};
/**
* The get operation response
*
* @generated from message mochabugapis.adapt.runtime.v1.GetExchangeOperationResponse
*/
export type GetExchangeOperationResponseJson = {
/**
* The actual operation
*
* @generated from field: mochabugapis.adapt.runtime.v1.ExchangeOperation item = 1;
*/
item?: ExchangeOperationJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.GetExchangeOperationResponse.
* Use `create(GetExchangeOperationResponseSchema)` to create a new message.
*/
export declare const GetExchangeOperationResponseSchema: GenMessage<GetExchangeOperationResponse, {
jsonType: GetExchangeOperationResponseJson;
}>;
/**
* A request to start execute an exchange
*
* @generated from message mochabugapis.adapt.runtime.v1.DispatchExchangeRequest
*/
export type DispatchExchangeRequest = Message<"mochabugapis.adapt.runtime.v1.DispatchExchangeRequest"> & {
/**
* The name of the exchange to dispatch
*
* @generated from field: string name = 1;
*/
name: string;
/**
* The receiver to send the signals on (on the exchange, mapps to transmitter on the subgraph)
*
* @generated from field: optional string receiver = 2;
*/
receiver?: string;
/**
* The signals to send over the receiver
*
* @generated from field: map<string, mochabugapis.adapt.graph.SignalData> signals = 3;
*/
signals: {
[key: string]: SignalData;
};
};
/**
* A request to start execute an exchange
*
* @generated from message mochabugapis.adapt.runtime.v1.DispatchExchangeRequest
*/
export type DispatchExchangeRequestJson = {
/**
* The name of the exchange to dispatch
*
* @generated from field: string name = 1;
*/
name?: string;
/**
* The receiver to send the signals on (on the exchange, mapps to transmitter on the subgraph)
*
* @generated from field: optional string receiver = 2;
*/
receiver?: string;
/**
* The signals to send over the receiver
*
* @generated from field: map<string, mochabugapis.adapt.graph.SignalData> signals = 3;
*/
signals?: {
[key: string]: SignalDataJson;
};
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.DispatchExchangeRequest.
* Use `create(DispatchExchangeRequestSchema)` to create a new message.
*/
export declare const DispatchExchangeRequestSchema: GenMessage<DispatchExchangeRequest, {
jsonType: DispatchExchangeRequestJson;
}>;
/**
* The response of the exchange execution
* Just like streams, this is an async operation
*
* @generated from message mochabugapis.adapt.runtime.v1.DispatchExchangeResponse
*/
export type DispatchExchangeResponse = Message<"mochabugapis.adapt.runtime.v1.DispatchExchangeResponse"> & {
/**
* The id of the operation
*
* @generated from field: mochabugapis.adapt.runtime.v1.ExchangeOperation operation = 1;
*/
operation?: ExchangeOperation;
};
/**
* The response of the exchange execution
* Just like streams, this is an async operation
*
* @generated from message mochabugapis.adapt.runtime.v1.DispatchExchangeResponse
*/
export type DispatchExchangeResponseJson = {
/**
* The id of the operation
*
* @generated from field: mochabugapis.adapt.runtime.v1.ExchangeOperation operation = 1;
*/
operation?: ExchangeOperationJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.DispatchExchangeResponse.
* Use `create(DispatchExchangeResponseSchema)` to create a new message.
*/
export declare const DispatchExchangeResponseSchema: GenMessage<DispatchExchangeResponse, {
jsonType: DispatchExchangeResponseJson;
}>;
/**
* A representation of an exchange operation
*
* @generated from message mochabugapis.adapt.runtime.v1.ExchangeOperation
*/
export type ExchangeOperation = Message<"mochabugapis.adapt.runtime.v1.ExchangeOperation"> & {
/**
* The name of the exchange
*
* @generated from field: string name = 1;
*/
name: string;
/**
* The id of the fork
*
* @generated from field: string id = 2;
*/
id: string;
/**
* The status of the operation
*
* @generated from field: mochabugapis.adapt.automations.v1.Status status = 3;
*/
status: Status;
};
/**
* A representation of an exchange operation
*
* @generated from message mochabugapis.adapt.runtime.v1.ExchangeOperation
*/
export type ExchangeOperationJson = {
/**
* The name of the exchange
*
* @generated from field: string name = 1;
*/
name?: string;
/**
* The id of the fork
*
* @generated from field: string id = 2;
*/
id?: string;
/**
* The status of the operation
*
* @generated from field: mochabugapis.adapt.automations.v1.Status status = 3;
*/
status?: StatusJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExchangeOperation.
* Use `create(ExchangeOperationSchema)` to create a new message.
*/
export declare const ExchangeOperationSchema: GenMessage<ExchangeOperation, {
jsonType: ExchangeOperationJson;
}>;
/**
* The complete execution request message
*
* @generated from message mochabugapis.adapt.runtime.v1.SendRequest
*/
export type SendRequest = Message<"mochabugapis.adapt.runtime.v1.SendRequest"> & {
/**
* The transmitter to send the signals on
*
* @generated from field: optional string transmitter = 1;
*/
transmitter?: string;
/**
* The signals to send over the transmitter
*
* @generated from field: map<string, mochabugapis.adapt.graph.SignalData> signals = 2;
*/
signals: {
[key: string]: SignalData;
};
};
/**
* The complete execution request message
*
* @generated from message mochabugapis.adapt.runtime.v1.SendRequest
*/
export type SendRequestJson = {
/**
* The transmitter to send the signals on
*
* @generated from field: optional string transmitter = 1;
*/
transmitter?: string;
/**
* The signals to send over the transmitter
*
* @generated from field: map<string, mochabugapis.adapt.graph.SignalData> signals = 2;
*/
signals?: {
[key: string]: SignalDataJson;
};
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.SendRequest.
* Use `create(SendRequestSchema)` to create a new message.
*/
export declare const SendRequestSchema: GenMessage<SendRequest, {
jsonType: SendRequestJson;
}>;
/**
* The complete execution response message
*
* @generated from message mochabugapis.adapt.runtime.v1.SendResponse
*/
export type SendResponse = Message<"mochabugapis.adapt.runtime.v1.SendResponse"> & {};
/**
* The complete execution response message
*
* @generated from message mochabugapis.adapt.runtime.v1.SendResponse
*/
export type SendResponseJson = {};
/**
* Describes the message mochabugapis.adapt.runtime.v1.SendResponse.
* Use `create(SendResponseSchema)` to create a new message.
*/
export declare const SendResponseSchema: GenMessage<SendResponse, {
jsonType: SendResponseJson;
}>;
/**
* The request to fetch multiple signals on the connected receiver
*
* @generated from message mochabugapis.adapt.runtime.v1.BatchGetActiveSignalsRequest
*/
export type BatchGetActiveSignalsRequest = Message<"mochabugapis.adapt.runtime.v1.BatchGetActiveSignalsRequest"> & {
/**
* The names of the signals to fetch
* An empty array will result in only fetching the connected receiver
*
* @generated from field: repeated string names = 1;
*/
names: string[];
};
/**
* The request to fetch multiple signals on the connected receiver
*
* @generated from message mochabugapis.adapt.runtime.v1.BatchGetActiveSignalsRequest
*/
export type BatchGetActiveSignalsRequestJson = {
/**
* The names of the signals to fetch
* An empty array will result in only fetching the connected receiver
*
* @generated from field: repeated string names = 1;
*/
names?: string[];
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.BatchGetActiveSignalsRequest.
* Use `create(BatchGetActiveSignalsRequestSchema)` to create a new message.
*/
export declare const BatchGetActiveSignalsRequestSchema: GenMessage<BatchGetActiveSignalsRequest, {
jsonType: BatchGetActiveSignalsRequestJson;
}>;
/**
* The response of getting multiple signals on the connected receiver
*
* @generated from message mochabugapis.adapt.runtime.v1.BatchGetActiveSignalsResponse
*/
export type BatchGetActiveSignalsResponse = Message<"mochabugapis.adapt.runtime.v1.BatchGetActiveSignalsResponse"> & {
/**
* The returned items, items not found are ignored
*
* @generated from field: map<string, mochabugapis.adapt.graph.SignalData> items = 1;
*/
items: {
[key: string]: SignalData;
};
/**
* The connected receiver
*
* @generated from field: string receiver = 2;
*/
receiver: string;
};
/**
* The response of getting multiple signals on the connected receiver
*
* @generated from message mochabugapis.adapt.runtime.v1.BatchGetActiveSignalsResponse
*/
export type BatchGetActiveSignalsResponseJson = {
/**
* The returned items, items not found are ignored
*
* @generated from field: map<string, mochabugapis.adapt.graph.SignalData> items = 1;
*/
items?: {
[key: string]: SignalDataJson;
};
/**
* The connected receiver
*
* @generated from field: string receiver = 2;
*/
receiver?: string;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.BatchGetActiveSignalsResponse.
* Use `create(BatchGetActiveSignalsResponseSchema)` to create a new message.
*/
export declare const BatchGetActiveSignalsResponseSchema: GenMessage<BatchGetActiveSignalsResponse, {
jsonType: BatchGetActiveSignalsResponseJson;
}>;
/**
* A request to fetch the signals on the connected receiver
*
* @generated from message mochabugapis.adapt.runtime.v1.ListActiveSignalsRequest
*/
export type ListActiveSignalsRequest = Message<"mochabugapis.adapt.runtime.v1.ListActiveSignalsRequest"> & {
/**
* The page size, defaults to 50
*
* @generated from field: optional int32 page_size = 1;
*/
pageSize?: number;
/**
* The cursor where to start the listing, defaults to beginning
* If the cursor is set, filter and order_by are ignored
*
* @generated from field: optional string cursor = 2;
*/
cursor?: string;
/**
* True if you want the result in descending order
*
* @generated from field: optional bool order_descending = 3;
*/
orderDescending?: boolean;
};
/**
* A request to fetch the signals on the connected receiver
*
* @generated from message mochabugapis.adapt.runtime.v1.ListActiveSignalsRequest
*/
export type ListActiveSignalsRequestJson = {
/**
* The page size, defaults to 50
*
* @generated from field: optional int32 page_size = 1;
*/
pageSize?: number;
/**
* The cursor where to start the listing, defaults to beginning
* If the cursor is set, filter and order_by are ignored
*
* @generated from field: optional string cursor = 2;
*/
cursor?: string;
/**
* True if you want the result in descending order
*
* @generated from field: optional bool order_descending = 3;
*/
orderDescending?: boolean;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ListActiveSignalsRequest.
* Use `create(ListActiveSignalsRequestSchema)` to create a new message.
*/
export declare const ListActiveSignalsRequestSchema: GenMessage<ListActiveSignalsRequest, {
jsonType: ListActiveSignalsRequestJson;
}>;
/**
* The response of fetching the recieved signals
*
* IMPORTANT: The response payload is limited to a maximum of 16MB.
* If the total size of all signals would exceed this limit, the response
* will be truncated and a next_cursor will be provided to continue fetching
* the remaining signals in subsequent requests.
*
* @generated from message mochabugapis.adapt.runtime.v1.ListActiveSignalsResponse
*/
export type ListActiveSignalsResponse = Message<"mochabugapis.adapt.runtime.v1.ListActiveSignalsResponse"> & {
/**
* The actual signals on the receiver
*
* @generated from field: map<string, mochabugapis.adapt.graph.SignalData> signals = 1;
*/
signals: {
[key: string]: SignalData;
};
/**
* The receiver the signals are fetched on
* The receiver must always be set, otherwise we cannot be inside a executor
*
* @generated from field: string receiver = 2;
*/
receiver: string;
/**
* Use this cursor in the next request to go through the collection
* Set if there's more data or if the 16MB payload limit was reached
*
* @generated from field: optional string next_cursor = 3;
*/
nextCursor?: string;
};
/**
* The response of fetching the recieved signals
*
* IMPORTANT: The response payload is limited to a maximum of 16MB.
* If the total size of all signals would exceed this limit, the response
* will be truncated and a next_cursor will be provided to continue fetching
* the remaining signals in subsequent requests.
*
* @generated from message mochabugapis.adapt.runtime.v1.ListActiveSignalsResponse
*/
export type ListActiveSignalsResponseJson = {
/**
* The actual signals on the receiver
*
* @generated from field: map<string, mochabugapis.adapt.graph.SignalData> signals = 1;
*/
signals?: {
[key: string]: SignalDataJson;
};
/**
* The receiver the signals are fetched on
* The receiver must always be set, otherwise we cannot be inside a executor
*
* @generated from field: string receiver = 2;
*/
receiver?: string;
/**
* Use this cursor in the next request to go through the collection
* Set if there's more data or if the 16MB payload limit was reached
*
* @generated from field: optional string next_cursor = 3;
*/
nextCursor?: string;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ListActiveSignalsResponse.
* Use `create(ListActiveSignalsResponseSchema)` to create a new message.
*/
export declare const ListActiveSignalsResponseSchema: GenMessage<ListActiveSignalsResponse, {
jsonType: ListActiveSignalsResponseJson;
}>;
/**
* The vertex config request
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceGetVertexConfigRequest
*/
export type ExecutorServiceGetVertexConfigRequest = Message<"mochabugapis.adapt.runtime.v1.ExecutorServiceGetVertexConfigRequest"> & {
/**
* An optional field mask
*
* @generated from field: optional google.protobuf.FieldMask field_mask = 1;
*/
fieldMask?: FieldMask;
};
/**
* The vertex config request
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceGetVertexConfigRequest
*/
export type ExecutorServiceGetVertexConfigRequestJson = {
/**
* An optional field mask
*
* @generated from field: optional google.protobuf.FieldMask field_mask = 1;
*/
fieldMask?: FieldMaskJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExecutorServiceGetVertexConfigRequest.
* Use `create(ExecutorServiceGetVertexConfigRequestSchema)` to create a new message.
*/
export declare const ExecutorServiceGetVertexConfigRequestSchema: GenMessage<ExecutorServiceGetVertexConfigRequest, {
jsonType: ExecutorServiceGetVertexConfigRequestJson;
}>;
/**
* The vertex config response
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceGetVertexConfigResponse
*/
export type ExecutorServiceGetVertexConfigResponse = Message<"mochabugapis.adapt.runtime.v1.ExecutorServiceGetVertexConfigResponse"> & {
/**
* The vertex config
*
* @generated from field: bytes config = 1;
*/
config: Uint8Array;
/**
* The metadata of the config
*
* @generated from field: mochabugapis.adapt.graph.VertexMetadata metadata = 2;
*/
metadata?: VertexMetadata;
/**
* The services that are actually configured on this vertex
* For nested services you query with a dot notation path
* Services that are not configured will not appear in this map
* For example, oneOf service with the selection option will appear as: "oneof_service.selected_option"
* Any grouped services will appear as normal, i.e. "grouped_service.nested_service"
* If the service is not configured (i.e. optional) it will not appear in this map
*
* @generated from field: map<string, bool> configured_services = 3;
*/
configuredServices: {
[key: string]: boolean;
};
};
/**
* The vertex config response
*
* @generated from message mochabugapis.adapt.runtime.v1.ExecutorServiceGetVertexConfigResponse
*/
export type ExecutorServiceGetVertexConfigResponseJson = {
/**
* The vertex config
*
* @generated from field: bytes config = 1;
*/
config?: string;
/**
* The metadata of the config
*
* @generated from field: mochabugapis.adapt.graph.VertexMetadata metadata = 2;
*/
metadata?: VertexMetadataJson;
/**
* The services that are actually configured on this vertex
* For nested services you query with a dot notation path
* Services that are not configured will not appear in this map
* For example, oneOf service with the selection option will appear as: "oneof_service.selected_option"
* Any grouped services will appear as normal, i.e. "grouped_service.nested_service"
* If the service is not configured (i.e. optional) it will not appear in this map
*
* @generated from field: map<string, bool> configured_services = 3;
*/
configuredServices?: {
[key: string]: boolean;
};
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ExecutorServiceGetVertexConfigResponse.
* Use `create(ExecutorServiceGetVertexConfigResponseSchema)` to create a new message.
*/
export declare const ExecutorServiceGetVertexConfigResponseSchema: GenMessage<ExecutorServiceGetVertexConfigResponse, {
jsonType: ExecutorServiceGetVertexConfigResponseJson;
}>;
/**
* The ListIncomingSignalsRequest is used to list the signals on the receiver you query
* If you have multiple receivers you should call this endpoint multiple times
*
* @generated from message mochabugapis.adapt.runtime.v1.ListIncomingSignalsRequest
*/
export type ListIncomingSignalsRequest = Message<"mochabugapis.adapt.runtime.v1.ListIncomingSignalsRequest"> & {
/**
* The receiver you want to check for signals, if not set, the first connected receiver is used
*
* @generated from field: optional string receiver = 1;
*/
receiver?: string;
/**
* Optional formats to filter the signals by. I.e. only return signals that subsumes to at least one schema in the array
*
* @generated from field: repeated mochabugapis.adapt.graph.SignalFormat formats = 2;
*/
formats: SignalFormat[];
/**
* A fieldmaks to apply to the returned schema
* I.e. if you want to omit logos you should set this to "vertices" + additional info
*
* @generated from field: optional google.protobuf.FieldMask field_mask = 3;
*/
fieldMask?: FieldMask;
};
/**
* The ListIncomingSignalsRequest is used to list the signals on the receiver you query
* If you have multiple receivers you should call this endpoint multiple times
*
* @generated from message mochabugapis.adapt.runtime.v1.ListIncomingSignalsRequest
*/
export type ListIncomingSignalsRequestJson = {
/**
* The receiver you want to check for signals, if not set, the first connected receiver is used
*
* @generated from field: optional string receiver = 1;
*/
receiver?: string;
/**
* Optional formats to filter the signals by. I.e. only return signals that subsumes to at least one schema in the array
*
* @generated from field: repeated mochabugapis.adapt.graph.SignalFormat formats = 2;
*/
formats?: SignalFormatJson[];
/**
* A fieldmaks to apply to the returned schema
* I.e. if you want to omit logos you should set this to "vertices" + additional info
*
* @generated from field: optional google.protobuf.FieldMask field_mask = 3;
*/
fieldMask?: FieldMaskJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ListIncomingSignalsRequest.
* Use `create(ListIncomingSignalsRequestSchema)` to create a new message.
*/
export declare const ListIncomingSignalsRequestSchema: GenMessage<ListIncomingSignalsRequest, {
jsonType: ListIncomingSignalsRequestJson;
}>;
/**
* A representation of a signal on a receiver
*
* @generated from message mochabugapis.adapt.runtime.v1.IncomingVertices
*/
export type IncomingVertices = Message<"mochabugapis.adapt.runtime.v1.IncomingVertices"> & {
/**
* The vertex id
*
* @generated from field: string id = 1;
*/
id: string;
/**
* The label
*
* @generated from field: string label = 2;
*/
label: string;
/**
* The description
*
* @generated from field: optional string description = 3;
*/
description?: string;
/**
* The transmitters on the vertex
*
* @generated from field: repeated mochabugapis.adapt.graph.Transmitter transmitters = 4;
*/
transmitters: Transmitter[];
/**
* We also need to know the vertex type
*
* @generated from field: mochabugapis.adapt.runtime.v1.VertexType vertex_type = 5;
*/
vertexType: VertexType;
/**
* Optional logo for the vertex, use it to get the logo from the map
*
* @generated from field: optional string logo_id = 6;
*/
logoId?: string;
};
/**
* A representation of a signal on a receiver
*
* @generated from message mochabugapis.adapt.runtime.v1.IncomingVertices
*/
export type IncomingVerticesJson = {
/**
* The vertex id
*
* @generated from field: string id = 1;
*/
id?: string;
/**
* The label
*
* @generated from field: string label = 2;
*/
label?: string;
/**
* The description
*
* @generated from field: optional string description = 3;
*/
description?: string;
/**
* The transmitters on the vertex
*
* @generated from field: repeated mochabugapis.adapt.graph.Transmitter transmitters = 4;
*/
transmitters?: TransmitterJson[];
/**
* We also need to know the vertex type
*
* @generated from field: mochabugapis.adapt.runtime.v1.VertexType vertex_type = 5;
*/
vertexType?: VertexTypeJson;
/**
* Optional logo for the vertex, use it to get the logo from the map
*
* @generated from field: optional string logo_id = 6;
*/
logoId?: string;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.IncomingVertices.
* Use `create(IncomingVerticesSchema)` to create a new message.
*/
export declare const IncomingVerticesSchema: GenMessage<IncomingVertices, {
jsonType: IncomingVerticesJson;
}>;
/**
* The ListIncomingSignalsResponse is used to return the signals on the receiver you query
*
* @generated from message mochabugapis.adapt.runtime.v1.ListIncomingSignalsResponse
*/
export type ListIncomingSignalsResponse = Message<"mochabugapis.adapt.runtime.v1.ListIncomingSignalsResponse"> & {
/**
* The incoming vertices
*
* @generated from field: repeated mochabugapis.adapt.runtime.v1.IncomingVertices vertices = 1;
*/
vertices: IncomingVertices[];
/**
* A map that maps vertex logo ids to logo
*
* @generated from field: map<string, string> vertex_logos = 2;
*/
vertexLogos: {
[key: string]: string;
};
/**
* The receiver the signals are fetched on
* This is set, since otherwise the request would return not found
*
* @generated from field: string receiver = 3;
*/
receiver: string;
};
/**
* The ListIncomingSignalsResponse is used to return the signals on the receiver you query
*
* @generated from message mochabugapis.adapt.runtime.v1.ListIncomingSignalsResponse
*/
export type ListIncomingSignalsResponseJson = {
/**
* The incoming vertices
*
* @generated from field: repeated mochabugapis.adapt.runtime.v1.IncomingVertices vertices = 1;
*/
vertices?: IncomingVerticesJson[];
/**
* A map that maps vertex logo ids to logo
*
* @generated from field: map<string, string> vertex_logos = 2;
*/
vertexLogos?: {
[key: string]: string;
};
/**
* The receiver the signals are fetched on
* This is set, since otherwise the request would return not found
*
* @generated from field: string receiver = 3;
*/
receiver?: string;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ListIncomingSignalsResponse.
* Use `create(ListIncomingSignalsResponseSchema)` to create a new message.
*/
export declare const ListIncomingSignalsResponseSchema: GenMessage<ListIncomingSignalsResponse, {
jsonType: ListIncomingSignalsResponseJson;
}>;
/**
* The batch store operation for the configuration store
*
* @generated from message mochabugapis.adapt.runtime.v1.ConfiguratorServiceBatchWriteStoreRequest
*/
export type ConfiguratorServiceBatchWriteStoreRequest = Message<"mochabugapis.adapt.runtime.v1.ConfiguratorServiceBatchWriteStoreRequest"> & {
/**
* A batch of operations to perform in the configurator store.
* Refer to the comments on the `StoreNamespace` enum for details on scope requirements.
*
* @generated from field: repeated mochabugapis.adapt.runtime.v1.WriteOperation operations = 1;
*/
operations: WriteOperation[];
/**
* The namespace where the batch is applied.
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace: Namespace;
};
/**
* The batch store operation for the configuration store
*
* @generated from message mochabugapis.adapt.runtime.v1.ConfiguratorServiceBatchWriteStoreRequest
*/
export type ConfiguratorServiceBatchWriteStoreRequestJson = {
/**
* A batch of operations to perform in the configurator store.
* Refer to the comments on the `StoreNamespace` enum for details on scope requirements.
*
* @generated from field: repeated mochabugapis.adapt.runtime.v1.WriteOperation operations = 1;
*/
operations?: WriteOperationJson[];
/**
* The namespace where the batch is applied.
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace?: NamespaceJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ConfiguratorServiceBatchWriteStoreRequest.
* Use `create(ConfiguratorServiceBatchWriteStoreRequestSchema)` to create a new message.
*/
export declare const ConfiguratorServiceBatchWriteStoreRequestSchema: GenMessage<ConfiguratorServiceBatchWriteStoreRequest, {
jsonType: ConfiguratorServiceBatchWriteStoreRequestJson;
}>;
/**
* The response of the batch store
*
* @generated from message mochabugapis.adapt.runtime.v1.ConfiguratorServiceBatchWriteStoreResponse
*/
export type ConfiguratorServiceBatchWriteStoreResponse = Message<"mochabugapis.adapt.runtime.v1.ConfiguratorServiceBatchWriteStoreResponse"> & {
/**
* Metadata for each written key.
* Note: Metadata is only returned for insert operations, not for delete operations.
*
* @generated from field: map<string, mochabugapis.adapt.runtime.v1.ValueMetadata> metadata = 1;
*/
metadata: {
[key: string]: ValueMetadata;
};
};
/**
* The response of the batch store
*
* @generated from message mochabugapis.adapt.runtime.v1.ConfiguratorServiceBatchWriteStoreResponse
*/
export type ConfiguratorServiceBatchWriteStoreResponseJson = {
/**
* Metadata for each written key.
* Note: Metadata is only returned for insert operations, not for delete operations.
*
* @generated from field: map<string, mochabugapis.adapt.runtime.v1.ValueMetadata> metadata = 1;
*/
metadata?: {
[key: string]: ValueMetadataJson;
};
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ConfiguratorServiceBatchWriteStoreResponse.
* Use `create(ConfiguratorServiceBatchWriteStoreResponseSchema)` to create a new message.
*/
export declare const ConfiguratorServiceBatchWriteStoreResponseSchema: GenMessage<ConfiguratorServiceBatchWriteStoreResponse, {
jsonType: ConfiguratorServiceBatchWriteStoreResponseJson;
}>;
/**
* The write store request
*
* @generated from message mochabugapis.adapt.runtime.v1.ConfiguratorServiceWriteStoreRequest
*/
export type ConfiguratorServiceWriteStoreRequest = Message<"mochabugapis.adapt.runtime.v1.ConfiguratorServiceWriteStoreRequest"> & {
/**
* The difference in the single write request is that we support conditional
* write operations here. These are useful for implementing locks etc.
* Conditional write operations behaves strangely inside a batch operation since
* the entire batch becomes conditional and they do not follow timestamps
*
* @generated from field: mochabugapis.adapt.runtime.v1.ConditionalWriteOperation operation = 1;
*/
operation?: ConditionalWriteOperation;
/**
* The namespace where the operation is applied.
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace: Namespace;
};
/**
* The write store request
*
* @generated from message mochabugapis.adapt.runtime.v1.ConfiguratorServiceWriteStoreRequest
*/
export type ConfiguratorServiceWriteStoreRequestJson = {
/**
* The difference in the single write request is that we support conditional
* write operations here. These are useful for implementing locks etc.
* Conditional write operations behaves strangely inside a batch operation since
* the entire batch becomes conditional and they do not follow timestamps
*
* @generated from field: mochabugapis.adapt.runtime.v1.ConditionalWriteOperation operation = 1;
*/
operation?: ConditionalWriteOperationJson;
/**
* The namespace where the operation is applied.
*
* @generated from field: mochabugapis.adapt.runtime.v1.Namespace namespace = 2;
*/
namespace?: NamespaceJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ConfiguratorServiceWriteStoreRequest.
* Use `create(ConfiguratorServiceWriteStoreRequestSchema)` to create a new message.
*/
export declare const ConfiguratorServiceWriteStoreRequestSchema: GenMessage<ConfiguratorServiceWriteStoreRequest, {
jsonType: ConfiguratorServiceWriteStoreRequestJson;
}>;
/**
* The response of the single write store
*
* @generated from message mochabugapis.adapt.runtime.v1.ConfiguratorServiceWriteStoreResponse
*/
export type ConfiguratorServiceWriteStoreResponse = Message<"mochabugapis.adapt.runtime.v1.ConfiguratorServiceWriteStoreResponse"> & {
/**
* The metadata for the written key.
* Note: Metadata is only returned for insert operations, not for delete operations.
*
* @generated from field: optional mochabugapis.adapt.runtime.v1.ValueMetadata metadata = 1;
*/
metadata?: ValueMetadata;
};
/**
* The response of the single write store
*
* @generated from message mochabugapis.adapt.runtime.v1.ConfiguratorServiceWriteStoreResponse
*/
export type ConfiguratorServiceWriteStoreResponseJson = {
/**
* The metadata for the written key.
* Note: Metadata is only returned for insert operations, not for delete operations.
*
* @generated from field: optional mochabugapis.adapt.runtime.v1.ValueMetadata metadata = 1;
*/
metadata?: ValueMetadataJson;
};
/**
* Describes the message mochabugapis.adapt.runtime.v1.ConfiguratorServiceWriteStoreResponse.
* Use `create(ConfiguratorServiceWriteStoreResponseSchema)` to create a new message.
*/
export declare const ConfiguratorServiceWriteStoreResponseSchema: GenMessage<ConfiguratorServiceWriteStoreResponse, {
jsonType: ConfiguratorServiceWriteStoreResponseJson;
}>;
/**
* The batch store operation for the configuration store
*
* @generated from message mochabugapis.adapt.runtime.v1.ConfiguratorServiceBatchReadStoreRequest
*/
export type ConfiguratorServiceBatchReadStoreRequest = Message<