spot-sdk-ts
Version:
TypeScript bindings based on protobufs (proto3) provided by Boston Dynamics
456 lines • 20.9 kB
TypeScript
import { RequestHeader, ResponseHeader } from "./header";
import _m0 from "protobufjs/minimal";
export declare const protobufPackage = "bosdyn.api";
/**
* A message representing a discoverable service. By definition, all services
* discoverable by this system are expected to be grpc "services" provided by
* some server.
*/
export interface ServiceEntry {
/** The unique user-friendly name of this service. */
name: string;
/**
* The type of this service. Usually identifies the underlying implementation.
* Does not have to be unique among all ServiceEntry objects.
*/
type: string;
/**
* Information used to route to the desired Service. Can either be a full address
* (aService.spot.robot) or just a DNS label that will be automatically converted to an
* address (aService).
*/
authority: string;
/**
* Last update time in robot timebase for this service record. This serves as the time of
* the last heartbeat to the robot.
*/
lastUpdate: Date | undefined;
/**
* If 'user_token_required' field is true, any requests to this service must contain
* a user token for the machine. Requests without a user token will result in a
* 401. Most services will want to require a user_token, but ones like auth_service
* do not.
*/
userTokenRequired: boolean;
/**
* If 'permission_required' field is non-empty, any requests to this service must
* have the same string in the "per" claim of the user token.
*/
permissionRequired: string;
/**
* Number of seconds to wait between heartbeats before assuming service in no longer live
* If unset (0) liveness checks will be disabled for this service.
*/
livenessTimeoutSecs: number;
/**
* The GUID of the payload that this service was registered from. An empty string represents a
* service that was registered via a client using standard user credentials or internal to the
* robot. This value is set automatically based on the user token and cannot be set or updated
* via the API, so it should not be populated by the client at registration time.
*/
hostPayloadGuid: string;
}
/**
* A message containing information that allows a client to identify a
* given endpoint host using an ip and a port.
*/
export interface Endpoint {
/** The IP address of the computer hosting this endpoint. */
hostIp: string;
/** The port number on which the endpoint is provided, between 0 and 65535. */
port: number;
}
/** The GetServiceEntry request message sends the service name to the robot. */
export interface GetServiceEntryRequest {
/** Common request header. */
header: RequestHeader | undefined;
/** The unique user-friendly name of the service. */
serviceName: string;
}
/** The GetServiceEntry response message returns a ServiceEntry for the desired service name. */
export interface GetServiceEntryResponse {
/** Common response Header. */
header: ResponseHeader | undefined;
/** Current status of the request. */
status: GetServiceEntryResponse_Status;
/** The record for the discovered service. Only set if 'status' field == STATUS_OK. */
serviceEntry: ServiceEntry | undefined;
}
export declare enum GetServiceEntryResponse_Status {
/** STATUS_UNKNOWN - UNKNOWN should never be used. An internal DirectoryService issue has happened if UNKNOWN is set. */
STATUS_UNKNOWN = 0,
/** STATUS_OK - GetService was successful. The service_entry field is filled out. */
STATUS_OK = 1,
/** STATUS_NONEXISTENT_SERVICE - GetService failed because the requested service name does not exist. */
STATUS_NONEXISTENT_SERVICE = 2,
UNRECOGNIZED = -1
}
export declare function getServiceEntryResponse_StatusFromJSON(object: any): GetServiceEntryResponse_Status;
export declare function getServiceEntryResponse_StatusToJSON(object: GetServiceEntryResponse_Status): string;
/** The ListServiceEntries request message will ask the robot for all services. */
export interface ListServiceEntriesRequest {
/** Common request header. */
header: RequestHeader | undefined;
}
/**
* The ListServiceEntries response message returns all known services at the time the request
* was recieved.
*/
export interface ListServiceEntriesResponse {
/** Common response header. */
header: ResponseHeader | undefined;
/** The resources managed by the LeaseService. */
serviceEntries: ServiceEntry[];
}
export declare const ServiceEntry: {
encode(message: ServiceEntry, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ServiceEntry;
fromJSON(object: any): ServiceEntry;
toJSON(message: ServiceEntry): unknown;
fromPartial<I extends {
name?: string | undefined;
type?: string | undefined;
authority?: string | undefined;
lastUpdate?: Date | undefined;
userTokenRequired?: boolean | undefined;
permissionRequired?: string | undefined;
livenessTimeoutSecs?: number | undefined;
hostPayloadGuid?: string | undefined;
} & {
name?: string | undefined;
type?: string | undefined;
authority?: string | undefined;
lastUpdate?: Date | undefined;
userTokenRequired?: boolean | undefined;
permissionRequired?: string | undefined;
livenessTimeoutSecs?: number | undefined;
hostPayloadGuid?: string | undefined;
} & { [K in Exclude<keyof I, keyof ServiceEntry>]: never; }>(object: I): ServiceEntry;
};
export declare const Endpoint: {
encode(message: Endpoint, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): Endpoint;
fromJSON(object: any): Endpoint;
toJSON(message: Endpoint): unknown;
fromPartial<I extends {
hostIp?: string | undefined;
port?: number | undefined;
} & {
hostIp?: string | undefined;
port?: number | undefined;
} & { [K in Exclude<keyof I, keyof Endpoint>]: never; }>(object: I): Endpoint;
};
export declare const GetServiceEntryRequest: {
encode(message: GetServiceEntryRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetServiceEntryRequest;
fromJSON(object: any): GetServiceEntryRequest;
toJSON(message: GetServiceEntryRequest): unknown;
fromPartial<I extends {
header?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
serviceName?: string | 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;
serviceName?: string | undefined;
} & { [K_1 in Exclude<keyof I, keyof GetServiceEntryRequest>]: never; }>(object: I): GetServiceEntryRequest;
};
export declare const GetServiceEntryResponse: {
encode(message: GetServiceEntryResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetServiceEntryResponse;
fromJSON(object: any): GetServiceEntryResponse;
toJSON(message: GetServiceEntryResponse): 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;
status?: GetServiceEntryResponse_Status | undefined;
serviceEntry?: {
name?: string | undefined;
type?: string | undefined;
authority?: string | undefined;
lastUpdate?: Date | undefined;
userTokenRequired?: boolean | undefined;
permissionRequired?: string | undefined;
livenessTimeoutSecs?: number | undefined;
hostPayloadGuid?: string | 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;
status?: GetServiceEntryResponse_Status | undefined;
serviceEntry?: ({
name?: string | undefined;
type?: string | undefined;
authority?: string | undefined;
lastUpdate?: Date | undefined;
userTokenRequired?: boolean | undefined;
permissionRequired?: string | undefined;
livenessTimeoutSecs?: number | undefined;
hostPayloadGuid?: string | undefined;
} & {
name?: string | undefined;
type?: string | undefined;
authority?: string | undefined;
lastUpdate?: Date | undefined;
userTokenRequired?: boolean | undefined;
permissionRequired?: string | undefined;
livenessTimeoutSecs?: number | undefined;
hostPayloadGuid?: string | undefined;
} & { [K_5 in Exclude<keyof I["serviceEntry"], keyof ServiceEntry>]: never; }) | undefined;
} & { [K_6 in Exclude<keyof I, keyof GetServiceEntryResponse>]: never; }>(object: I): GetServiceEntryResponse;
};
export declare const ListServiceEntriesRequest: {
encode(message: ListServiceEntriesRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ListServiceEntriesRequest;
fromJSON(object: any): ListServiceEntriesRequest;
toJSON(message: ListServiceEntriesRequest): unknown;
fromPartial<I extends {
header?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | 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;
} & { [K_1 in Exclude<keyof I, "header">]: never; }>(object: I): ListServiceEntriesRequest;
};
export declare const ListServiceEntriesResponse: {
encode(message: ListServiceEntriesResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ListServiceEntriesResponse;
fromJSON(object: any): ListServiceEntriesResponse;
toJSON(message: ListServiceEntriesResponse): 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;
serviceEntries?: {
name?: string | undefined;
type?: string | undefined;
authority?: string | undefined;
lastUpdate?: Date | undefined;
userTokenRequired?: boolean | undefined;
permissionRequired?: string | undefined;
livenessTimeoutSecs?: number | undefined;
hostPayloadGuid?: string | 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;
serviceEntries?: ({
name?: string | undefined;
type?: string | undefined;
authority?: string | undefined;
lastUpdate?: Date | undefined;
userTokenRequired?: boolean | undefined;
permissionRequired?: string | undefined;
livenessTimeoutSecs?: number | undefined;
hostPayloadGuid?: string | undefined;
}[] & ({
name?: string | undefined;
type?: string | undefined;
authority?: string | undefined;
lastUpdate?: Date | undefined;
userTokenRequired?: boolean | undefined;
permissionRequired?: string | undefined;
livenessTimeoutSecs?: number | undefined;
hostPayloadGuid?: string | undefined;
} & {
name?: string | undefined;
type?: string | undefined;
authority?: string | undefined;
lastUpdate?: Date | undefined;
userTokenRequired?: boolean | undefined;
permissionRequired?: string | undefined;
livenessTimeoutSecs?: number | undefined;
hostPayloadGuid?: string | undefined;
} & { [K_5 in Exclude<keyof I["serviceEntries"][number], keyof ServiceEntry>]: never; })[] & { [K_6 in Exclude<keyof I["serviceEntries"], keyof {
name?: string | undefined;
type?: string | undefined;
authority?: string | undefined;
lastUpdate?: Date | undefined;
userTokenRequired?: boolean | undefined;
permissionRequired?: string | undefined;
livenessTimeoutSecs?: number | undefined;
hostPayloadGuid?: string | undefined;
}[]>]: never; }) | undefined;
} & { [K_7 in Exclude<keyof I, keyof ListServiceEntriesResponse>]: never; }>(object: I): ListServiceEntriesResponse;
};
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=directory.d.ts.map