spot-sdk-ts
Version:
TypeScript bindings based on protobufs (proto3) provided by Boston Dynamics
180 lines • 7.88 kB
TypeScript
import { Any } from "../../google/protobuf/any";
import _m0 from "protobufjs/minimal";
export declare const protobufPackage = "bosdyn.api";
/** Standard header attached to all GRPC requests to services. */
export interface RequestHeader {
/** Time that the request was sent, as measured by the client's local system clock. */
requestTimestamp: Date | undefined;
/**
* Name of the client to identify itself. The name will typically include a
* symbolic string to identify the program, and a unique integer to identify
* the specific instance of the process running.
*/
clientName: string;
/**
* If Set to true, request that request and response messages for this call are not recorded
* in the GRPC log.
*/
disableRpcLogging: boolean;
}
/**
* General error code are returned in the header to facilitate error-handling which is not
* message-specific.
* This can be used for generic error handlers, aggregation, and trend analysis.
*/
export interface CommonError {
/** The different error codes that can be returned on a grpc response message. */
code: CommonError_Code;
/** Human-readable error description. Not for programmatic analysis. */
message: string;
/** Extra information that can optionally be provided for generic error handling/analysis. */
data: Any | undefined;
}
export declare enum CommonError_Code {
/** CODE_UNSPECIFIED - Code is not specified. */
CODE_UNSPECIFIED = 0,
/** CODE_OK - Not an error. Request was successful. */
CODE_OK = 1,
/** CODE_INTERNAL_SERVER_ERROR - Service experienced an unexpected error state. */
CODE_INTERNAL_SERVER_ERROR = 2,
/** CODE_INVALID_REQUEST - Ill-formed request. Request arguments were not valid. */
CODE_INVALID_REQUEST = 3,
UNRECOGNIZED = -1
}
export declare function commonError_CodeFromJSON(object: any): CommonError_Code;
export declare function commonError_CodeToJSON(object: CommonError_Code): string;
/** Standard header attached to all GRPC responses from services. */
export interface ResponseHeader {
/** Echo-back the RequestHeader for timing information, etc.... */
requestHeader: RequestHeader | undefined;
/** Time that the request was received. The server clock is the time basis. */
requestReceivedTimestamp: Date | undefined;
/** Time that the response was received. The server clock is the time basis. */
responseTimestamp: Date | undefined;
/**
* Common errors, such as invalid input or internal server problems.
* If there is a common error, the rest of the response message outside of the
* ResponseHeader will be invalid.
*/
error: CommonError | undefined;
/**
* Echoed request message. In some cases it may not be present, or it may be a stripped
* down representation of the request.
*/
request: Any | undefined;
}
export declare const RequestHeader: {
encode(message: RequestHeader, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): RequestHeader;
fromJSON(object: any): RequestHeader;
toJSON(message: RequestHeader): unknown;
fromPartial<I extends {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & { [K in Exclude<keyof I, keyof RequestHeader>]: never; }>(object: I): RequestHeader;
};
export declare const CommonError: {
encode(message: CommonError, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CommonError;
fromJSON(object: any): CommonError;
toJSON(message: CommonError): unknown;
fromPartial<I extends {
code?: CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
code?: CommonError_Code | undefined;
message?: string | undefined;
data?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K in Exclude<keyof I["data"], keyof Any>]: never; }) | undefined;
} & { [K_1 in Exclude<keyof I, keyof CommonError>]: never; }>(object: I): CommonError;
};
export declare const ResponseHeader: {
encode(message: ResponseHeader, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ResponseHeader;
fromJSON(object: any): ResponseHeader;
toJSON(message: ResponseHeader): unknown;
fromPartial<I extends {
requestHeader?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: {
code?: 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["requestHeader"], keyof RequestHeader>]: never; }) | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: ({
code?: CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
code?: 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["error"]["data"], keyof Any>]: never; }) | undefined;
} & { [K_2 in Exclude<keyof I["error"], keyof CommonError>]: never; }) | undefined;
request?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K_3 in Exclude<keyof I["request"], keyof Any>]: never; }) | undefined;
} & { [K_4 in Exclude<keyof I, keyof ResponseHeader>]: never; }>(object: I): ResponseHeader;
};
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=header.d.ts.map