spot-sdk-ts
Version:
TypeScript bindings based on protobufs (proto3) provided by Boston Dynamics
529 lines • 24.4 kB
TypeScript
import { RequestHeader, ResponseHeader } from "./header";
import _m0 from "protobufjs/minimal";
export declare const protobufPackage = "bosdyn.api";
/**
* DEPRECATED as of 2.1.0: Please use the DataBufferService instead of the LogAnnotationService.
* The AddLogAnnotation request sends the information that should be added into the log.
*/
export interface AddLogAnnotationRequest {
/** Common request/response header. */
header: RequestHeader | undefined;
/** The annotations to be aded into the log (can be text messages, blobs or robot operator messages). */
annotations: LogAnnotations | undefined;
}
/**
* DEPRECATED as of 2.1.0: Please use the DataBufferService instead of the LogAnnotationService.
* A container for elements to be added to the robot's logs.
*/
export interface LogAnnotations {
/** Text messages to be added to the log. */
textMessages: LogAnnotationTextMessage[];
/** Messages from the robot operator to be added to the log. */
operatorMessages: LogAnnotationOperatorMessage[];
/** One or more binary blobs to add to the log. */
blobData: LogAnnotationLogBlob[];
}
/**
* DEPRECATED as of 2.1.0: Please use the DataBufferService instead of the LogAnnotationService.
* A text message to add to the robot's logs.
* These could be internal text-log messages from a client for use in debugging, for
* example.
*/
export interface LogAnnotationTextMessage {
/** String annotation message to add to the log. */
message: string;
/** Required timestamp of data in robot clock time. */
timestamp: Date | undefined;
/** The service responsible for the annotation. May be omitted. */
service: string;
/** Level of significance of the text message. */
level: LogAnnotationTextMessage_Level;
/** Optional tag to identify from what code/module this message originated from. */
tag: string;
/** Optional source file name originating the log message. */
filename: string;
/** Optional source file line number originating the log message. */
lineNumber: number;
/** Optional timestamp of data in client clock time. */
timestampClient: Date | undefined;
}
export declare enum LogAnnotationTextMessage_Level {
/** LEVEL_UNKNOWN - Invalid, do not use. */
LEVEL_UNKNOWN = 0,
/** LEVEL_DEBUG - Events likely of interest only in a debugging context. */
LEVEL_DEBUG = 1,
/** LEVEL_INFO - Informational message during normal operation. */
LEVEL_INFO = 2,
/** LEVEL_WARN - Information about an unexpected but recoverable condition. */
LEVEL_WARN = 3,
/** LEVEL_ERROR - Information about an operation which did not succeed. */
LEVEL_ERROR = 4,
UNRECOGNIZED = -1
}
export declare function logAnnotationTextMessage_LevelFromJSON(object: any): LogAnnotationTextMessage_Level;
export declare function logAnnotationTextMessage_LevelToJSON(object: LogAnnotationTextMessage_Level): string;
/**
* DEPRECATED as of 2.1.0: Please use the DataBufferService instead of the LogAnnotationService.
* An operator message to be added to the robot's logs.
* These are notes especially intended to mark when logs should be preserved and reviewed
* to ensure that robot hardware and/or software is working as intended.
*/
export interface LogAnnotationOperatorMessage {
/** String annotation message to add to the log. */
message: string;
/** Required timestamp of data in robot clock time. */
timestamp: Date | undefined;
/** Optional timestamp of data in client clock time. */
timestampClient: Date | undefined;
}
/**
* DEPRECATED as of 2.1.0: Please use the DataBufferService instead of the LogAnnotationService.
* A unit of binary data to be entered in a log.
*/
export interface LogAnnotationLogBlob {
/** Required timestamp of data in robot clock time. */
timestamp: Date | undefined;
/**
* A general label for this blob.
* This is distinct from type_id, which identifies how the blob is to be parsed.
*/
channel: string;
/**
* A description of the data's content and its encoding.
* This should be sufficient for deciding how to deserialize the data.
* For example, this could be the full name of a protobuf message type.
*/
typeId: string;
/** Raw data to be included as the blob log. */
data: Uint8Array;
/** Optional timestamp of data in client clock time. */
timestampClient: Date | undefined;
}
/**
* DEPRECATED as of 2.1.0: Please use the DataBufferService instead of the LogAnnotationService.
* The AddLogAnnotation response message, which is empty except for any potential header errors/warnings.
*/
export interface AddLogAnnotationResponse {
/** Common request/response header. */
header: ResponseHeader | undefined;
}
export declare const AddLogAnnotationRequest: {
encode(message: AddLogAnnotationRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): AddLogAnnotationRequest;
fromJSON(object: any): AddLogAnnotationRequest;
toJSON(message: AddLogAnnotationRequest): unknown;
fromPartial<I extends {
header?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
annotations?: {
textMessages?: {
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
}[] | undefined;
operatorMessages?: {
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
}[] | undefined;
blobData?: {
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
}[] | undefined;
} | undefined;
} & {
header?: ({
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & { [K in Exclude<keyof I["header"], keyof RequestHeader>]: never; }) | undefined;
annotations?: ({
textMessages?: {
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
}[] | undefined;
operatorMessages?: {
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
}[] | undefined;
blobData?: {
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
}[] | undefined;
} & {
textMessages?: ({
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
}[] & ({
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
} & {
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
} & { [K_1 in Exclude<keyof I["annotations"]["textMessages"][number], keyof LogAnnotationTextMessage>]: never; })[] & { [K_2 in Exclude<keyof I["annotations"]["textMessages"], keyof {
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
}[]>]: never; }) | undefined;
operatorMessages?: ({
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
}[] & ({
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
} & {
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
} & { [K_3 in Exclude<keyof I["annotations"]["operatorMessages"][number], keyof LogAnnotationOperatorMessage>]: never; })[] & { [K_4 in Exclude<keyof I["annotations"]["operatorMessages"], keyof {
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
}[]>]: never; }) | undefined;
blobData?: ({
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
}[] & ({
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
} & {
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
} & { [K_5 in Exclude<keyof I["annotations"]["blobData"][number], keyof LogAnnotationLogBlob>]: never; })[] & { [K_6 in Exclude<keyof I["annotations"]["blobData"], keyof {
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
}[]>]: never; }) | undefined;
} & { [K_7 in Exclude<keyof I["annotations"], keyof LogAnnotations>]: never; }) | undefined;
} & { [K_8 in Exclude<keyof I, keyof AddLogAnnotationRequest>]: never; }>(object: I): AddLogAnnotationRequest;
};
export declare const LogAnnotations: {
encode(message: LogAnnotations, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LogAnnotations;
fromJSON(object: any): LogAnnotations;
toJSON(message: LogAnnotations): unknown;
fromPartial<I extends {
textMessages?: {
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
}[] | undefined;
operatorMessages?: {
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
}[] | undefined;
blobData?: {
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
}[] | undefined;
} & {
textMessages?: ({
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
}[] & ({
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
} & {
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
} & { [K in Exclude<keyof I["textMessages"][number], keyof LogAnnotationTextMessage>]: never; })[] & { [K_1 in Exclude<keyof I["textMessages"], keyof {
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
}[]>]: never; }) | undefined;
operatorMessages?: ({
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
}[] & ({
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
} & {
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
} & { [K_2 in Exclude<keyof I["operatorMessages"][number], keyof LogAnnotationOperatorMessage>]: never; })[] & { [K_3 in Exclude<keyof I["operatorMessages"], keyof {
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
}[]>]: never; }) | undefined;
blobData?: ({
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
}[] & ({
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
} & {
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
} & { [K_4 in Exclude<keyof I["blobData"][number], keyof LogAnnotationLogBlob>]: never; })[] & { [K_5 in Exclude<keyof I["blobData"], keyof {
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
}[]>]: never; }) | undefined;
} & { [K_6 in Exclude<keyof I, keyof LogAnnotations>]: never; }>(object: I): LogAnnotations;
};
export declare const LogAnnotationTextMessage: {
encode(message: LogAnnotationTextMessage, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LogAnnotationTextMessage;
fromJSON(object: any): LogAnnotationTextMessage;
toJSON(message: LogAnnotationTextMessage): unknown;
fromPartial<I extends {
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
} & {
message?: string | undefined;
timestamp?: Date | undefined;
service?: string | undefined;
level?: LogAnnotationTextMessage_Level | undefined;
tag?: string | undefined;
filename?: string | undefined;
lineNumber?: number | undefined;
timestampClient?: Date | undefined;
} & { [K in Exclude<keyof I, keyof LogAnnotationTextMessage>]: never; }>(object: I): LogAnnotationTextMessage;
};
export declare const LogAnnotationOperatorMessage: {
encode(message: LogAnnotationOperatorMessage, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LogAnnotationOperatorMessage;
fromJSON(object: any): LogAnnotationOperatorMessage;
toJSON(message: LogAnnotationOperatorMessage): unknown;
fromPartial<I extends {
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
} & {
message?: string | undefined;
timestamp?: Date | undefined;
timestampClient?: Date | undefined;
} & { [K in Exclude<keyof I, keyof LogAnnotationOperatorMessage>]: never; }>(object: I): LogAnnotationOperatorMessage;
};
export declare const LogAnnotationLogBlob: {
encode(message: LogAnnotationLogBlob, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LogAnnotationLogBlob;
fromJSON(object: any): LogAnnotationLogBlob;
toJSON(message: LogAnnotationLogBlob): unknown;
fromPartial<I extends {
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
} & {
timestamp?: Date | undefined;
channel?: string | undefined;
typeId?: string | undefined;
data?: Uint8Array | undefined;
timestampClient?: Date | undefined;
} & { [K in Exclude<keyof I, keyof LogAnnotationLogBlob>]: never; }>(object: I): LogAnnotationLogBlob;
};
export declare const AddLogAnnotationResponse: {
encode(message: AddLogAnnotationResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): AddLogAnnotationResponse;
fromJSON(object: any): AddLogAnnotationResponse;
toJSON(message: AddLogAnnotationResponse): unknown;
fromPartial<I extends {
header?: {
requestHeader?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: {
code?: import("./header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
request?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
} & {
header?: ({
requestHeader?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: {
code?: import("./header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
request?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
requestHeader?: ({
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & { [K in Exclude<keyof I["header"]["requestHeader"], keyof RequestHeader>]: never; }) | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: ({
code?: import("./header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
code?: import("./header").CommonError_Code | undefined;
message?: string | undefined;
data?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K_1 in Exclude<keyof I["header"]["error"]["data"], keyof import("../../google/protobuf/any").Any>]: never; }) | undefined;
} & { [K_2 in Exclude<keyof I["header"]["error"], keyof import("./header").CommonError>]: never; }) | undefined;
request?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K_3 in Exclude<keyof I["header"]["request"], keyof import("../../google/protobuf/any").Any>]: never; }) | undefined;
} & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined;
} & { [K_5 in Exclude<keyof I, "header">]: never; }>(object: I): AddLogAnnotationResponse;
};
declare type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
export declare type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
[K in keyof T]?: DeepPartial<T[K]>;
} : Partial<T>;
declare type KeysOfUnion<T> = T extends T ? keyof T : never;
export declare type Exact<P, I extends P> = P extends Builtin ? P : P & {
[K in keyof P]: Exact<P[K], I[K]>;
} & {
[K in Exclude<keyof I, KeysOfUnion<P>>]: never;
};
export {};
//# sourceMappingURL=log_annotation.d.ts.map