// @generated by protoc-gen-es v1.10.0 // @generated from file service/shell/v1/shell.proto (package viam.service.shell.v1, syntax proto3) /* eslint-disable */ // @ts-nocheck import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage, Struct, Timestamp } from "@bufbuild/protobuf"; import { Message, proto3 } from "@bufbuild/protobuf"; /** * CopyFilesSourceType indicates what will be copied. It's important * to disambiguate the single directory case from the multiple files * case in order to indicate that the user's intent is to copy a directory * into a single location which may result in a new top-level directory versus * the cause of multiples files that always go into the existing target destination. * * @generated from enum viam.service.shell.v1.CopyFilesSourceType */ export declare enum CopyFilesSourceType { /** * @generated from enum value: COPY_FILES_SOURCE_TYPE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** * @generated from enum value: COPY_FILES_SOURCE_TYPE_SINGLE_FILE = 1; */ SINGLE_FILE = 1, /** * @generated from enum value: COPY_FILES_SOURCE_TYPE_SINGLE_DIRECTORY = 2; */ SINGLE_DIRECTORY = 2, /** * @generated from enum value: COPY_FILES_SOURCE_TYPE_MULTIPLE_FILES = 3; */ MULTIPLE_FILES = 3, } /** * @generated from message viam.service.shell.v1.ShellRequest */ export declare class ShellRequest extends Message { /** * @generated from field: string name = 1; */ name: string; /** * @generated from field: string data_in = 2; */ dataIn: string; /** * Additional arguments to the method * * @generated from field: google.protobuf.Struct extra = 99; */ extra?: Struct; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "viam.service.shell.v1.ShellRequest"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): ShellRequest; static fromJson(jsonValue: JsonValue, options?: Partial): ShellRequest; static fromJsonString(jsonString: string, options?: Partial): ShellRequest; static equals(a: ShellRequest | PlainMessage | undefined, b: ShellRequest | PlainMessage | undefined): boolean; } /** * @generated from message viam.service.shell.v1.ShellResponse */ export declare class ShellResponse extends Message { /** * @generated from field: string data_out = 1; */ dataOut: string; /** * @generated from field: string data_err = 2; */ dataErr: string; /** * @generated from field: bool eof = 3; */ eof: boolean; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "viam.service.shell.v1.ShellResponse"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): ShellResponse; static fromJson(jsonValue: JsonValue, options?: Partial): ShellResponse; static fromJsonString(jsonString: string, options?: Partial): ShellResponse; static equals(a: ShellResponse | PlainMessage | undefined, b: ShellResponse | PlainMessage | undefined): boolean; } /** * FileData contains partial (sometimes complete) information about a File. * When transmitting FileData with CopyFilesToMachine and CopyFilesFromMachine, * it MUST initially contain its name, size, and is_dir. Depending on whether * preservation is in use, the mod_time and mode fields may be initially set * as well. On all transmissions, data and eof must be set. Because files are * sent one-by-one, it is currently permitted to exclude the initially set fields. * If this ever changes, a new scheme should be used for identifying files (like a number) * in order to reduce data transmission while allowing out-of-order transfers. * eof must be true and its own message once no more data is to be sent for this file. * * @generated from message viam.service.shell.v1.FileData */ export declare class FileData extends Message { /** * @generated from field: string name = 1; */ name: string; /** * @generated from field: int64 size = 2; */ size: bigint; /** * @generated from field: bool is_dir = 3; */ isDir: boolean; /** * @generated from field: bytes data = 4; */ data: Uint8Array; /** * @generated from field: bool eof = 5; */ eof: boolean; /** * Note(erd): maybe support access time in the future if needed * * @generated from field: optional google.protobuf.Timestamp mod_time = 6; */ modTime?: Timestamp; /** * @generated from field: optional uint32 mode = 7; */ mode?: number; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "viam.service.shell.v1.FileData"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): FileData; static fromJson(jsonValue: JsonValue, options?: Partial): FileData; static fromJsonString(jsonString: string, options?: Partial): FileData; static equals(a: FileData | PlainMessage | undefined, b: FileData | PlainMessage | undefined): boolean; } /** * @generated from message viam.service.shell.v1.CopyFilesToMachineRequestMetadata */ export declare class CopyFilesToMachineRequestMetadata extends Message { /** * name is the service name. * * @generated from field: string name = 1; */ name: string; /** * source_type is the type of files that will be transmitted in this request stream. * * @generated from field: viam.service.shell.v1.CopyFilesSourceType source_type = 2; */ sourceType: CopyFilesSourceType; /** * destination is where the files should be placed. The receiver can choose to * reasonably modify this destination based on its implementation semantics. * * @generated from field: string destination = 3; */ destination: string; /** * preserve indicates the the receiver should use the metadata in the file to reflect * the same state in its filesystem as applicable. * * @generated from field: bool preserve = 4; */ preserve: boolean; /** * Additional arguments to the method * * @generated from field: google.protobuf.Struct extra = 99; */ extra?: Struct; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "viam.service.shell.v1.CopyFilesToMachineRequestMetadata"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): CopyFilesToMachineRequestMetadata; static fromJson(jsonValue: JsonValue, options?: Partial): CopyFilesToMachineRequestMetadata; static fromJsonString(jsonString: string, options?: Partial): CopyFilesToMachineRequestMetadata; static equals(a: CopyFilesToMachineRequestMetadata | PlainMessage | undefined, b: CopyFilesToMachineRequestMetadata | PlainMessage | undefined): boolean; } /** * @generated from message viam.service.shell.v1.CopyFilesToMachineRequest */ export declare class CopyFilesToMachineRequest extends Message { /** * @generated from oneof viam.service.shell.v1.CopyFilesToMachineRequest.request */ request: { /** * metadata is sent first and only once. * * @generated from field: viam.service.shell.v1.CopyFilesToMachineRequestMetadata metadata = 1; */ value: CopyFilesToMachineRequestMetadata; case: "metadata"; } | { /** * file_data is sent only after metadata. All data MUST be sent * in order per-file. * * @generated from field: viam.service.shell.v1.FileData file_data = 2; */ value: FileData; case: "fileData"; } | { case: undefined; value?: undefined }; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "viam.service.shell.v1.CopyFilesToMachineRequest"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): CopyFilesToMachineRequest; static fromJson(jsonValue: JsonValue, options?: Partial): CopyFilesToMachineRequest; static fromJsonString(jsonString: string, options?: Partial): CopyFilesToMachineRequest; static equals(a: CopyFilesToMachineRequest | PlainMessage | undefined, b: CopyFilesToMachineRequest | PlainMessage | undefined): boolean; } /** * @generated from message viam.service.shell.v1.CopyFilesToMachineResponse */ export declare class CopyFilesToMachineResponse extends Message { /** * value does not matter here but responses must be sent after every * file has been received. * * @generated from field: bool ack_last_file = 1; */ ackLastFile: boolean; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "viam.service.shell.v1.CopyFilesToMachineResponse"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): CopyFilesToMachineResponse; static fromJson(jsonValue: JsonValue, options?: Partial): CopyFilesToMachineResponse; static fromJsonString(jsonString: string, options?: Partial): CopyFilesToMachineResponse; static equals(a: CopyFilesToMachineResponse | PlainMessage | undefined, b: CopyFilesToMachineResponse | PlainMessage | undefined): boolean; } /** * @generated from message viam.service.shell.v1.CopyFilesFromMachineRequestMetadata */ export declare class CopyFilesFromMachineRequestMetadata extends Message { /** * name is the service name. * * @generated from field: string name = 1; */ name: string; /** * paths are the paths to copy from and send back over the wire. * * @generated from field: repeated string paths = 2; */ paths: string[]; /** * allow_recursion indicates if directories should be recursed into. If * a directory is encountered and this is false, an error MUST occur. * * @generated from field: bool allow_recursion = 3; */ allowRecursion: boolean; /** * preserve indicates the the receiver should provide the metadata in the file * to reflect the same state in the sender's filesystem as applicable. * * @generated from field: bool preserve = 4; */ preserve: boolean; /** * Additional arguments to the method * * @generated from field: google.protobuf.Struct extra = 99; */ extra?: Struct; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "viam.service.shell.v1.CopyFilesFromMachineRequestMetadata"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): CopyFilesFromMachineRequestMetadata; static fromJson(jsonValue: JsonValue, options?: Partial): CopyFilesFromMachineRequestMetadata; static fromJsonString(jsonString: string, options?: Partial): CopyFilesFromMachineRequestMetadata; static equals(a: CopyFilesFromMachineRequestMetadata | PlainMessage | undefined, b: CopyFilesFromMachineRequestMetadata | PlainMessage | undefined): boolean; } /** * @generated from message viam.service.shell.v1.CopyFilesFromMachineRequest */ export declare class CopyFilesFromMachineRequest extends Message { /** * @generated from oneof viam.service.shell.v1.CopyFilesFromMachineRequest.request */ request: { /** * metadata is sent first and only once. * * @generated from field: viam.service.shell.v1.CopyFilesFromMachineRequestMetadata metadata = 1; */ value: CopyFilesFromMachineRequestMetadata; case: "metadata"; } | { /** * ack_last_file is sent only after metadata and after each file has been received. * The value does not matter. * * @generated from field: bool ack_last_file = 2; */ value: boolean; case: "ackLastFile"; } | { case: undefined; value?: undefined }; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "viam.service.shell.v1.CopyFilesFromMachineRequest"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): CopyFilesFromMachineRequest; static fromJson(jsonValue: JsonValue, options?: Partial): CopyFilesFromMachineRequest; static fromJsonString(jsonString: string, options?: Partial): CopyFilesFromMachineRequest; static equals(a: CopyFilesFromMachineRequest | PlainMessage | undefined, b: CopyFilesFromMachineRequest | PlainMessage | undefined): boolean; } /** * @generated from message viam.service.shell.v1.CopyFilesFromMachineResponseMetadata */ export declare class CopyFilesFromMachineResponseMetadata extends Message { /** * source_type is the type of files that will be transmitted in this response stream. * * @generated from field: viam.service.shell.v1.CopyFilesSourceType source_type = 1; */ sourceType: CopyFilesSourceType; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "viam.service.shell.v1.CopyFilesFromMachineResponseMetadata"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): CopyFilesFromMachineResponseMetadata; static fromJson(jsonValue: JsonValue, options?: Partial): CopyFilesFromMachineResponseMetadata; static fromJsonString(jsonString: string, options?: Partial): CopyFilesFromMachineResponseMetadata; static equals(a: CopyFilesFromMachineResponseMetadata | PlainMessage | undefined, b: CopyFilesFromMachineResponseMetadata | PlainMessage | undefined): boolean; } /** * @generated from message viam.service.shell.v1.CopyFilesFromMachineResponse */ export declare class CopyFilesFromMachineResponse extends Message { /** * @generated from oneof viam.service.shell.v1.CopyFilesFromMachineResponse.response */ response: { /** * metadata is sent first and only once. * * @generated from field: viam.service.shell.v1.CopyFilesFromMachineResponseMetadata metadata = 1; */ value: CopyFilesFromMachineResponseMetadata; case: "metadata"; } | { /** * file_data is sent only after metadata. All data MUST be sent * in order per-file. * * @generated from field: viam.service.shell.v1.FileData file_data = 2; */ value: FileData; case: "fileData"; } | { case: undefined; value?: undefined }; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "viam.service.shell.v1.CopyFilesFromMachineResponse"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): CopyFilesFromMachineResponse; static fromJson(jsonValue: JsonValue, options?: Partial): CopyFilesFromMachineResponse; static fromJsonString(jsonString: string, options?: Partial): CopyFilesFromMachineResponse; static equals(a: CopyFilesFromMachineResponse | PlainMessage | undefined, b: CopyFilesFromMachineResponse | PlainMessage | undefined): boolean; }