the-moby-effect
Version:
Moby/Docker API client built using effect-ts
72 lines • 2.87 kB
TypeScript
import * as Schema from "effect/Schema";
import * as MobySchemas from "../schemas/index.js";
import * as VolumeTopology from "./VolumeTopology.generated.js";
declare const VolumeInfo_base: Schema.Class<VolumeInfo, {
/**
* CapacityBytes is the capacity of the volume in bytes. A value of 0
* indicates that the capacity is unknown.
*/
CapacityBytes: Schema.optional<MobySchemas.Int64Schemas.$Int64>;
/**
* VolumeContext is the context originating from the CSI storage plugin
* when the Volume is created.
*/
VolumeContext: Schema.optionalWith<Schema.Record$<typeof Schema.String, typeof Schema.String>, {
nullable: true;
}>;
/**
* VolumeID is the ID of the Volume as seen by the CSI storage plugin.
* This is distinct from the Volume's Swarm ID, which is the ID used by
* all of the Docker Engine to refer to the Volume. If this field is
* blank, then the Volume has not been successfully created yet.
*/
VolumeID: Schema.optional<typeof Schema.String>;
/**
* AccessibleTopology is the topology this volume is actually accessible
* from.
*/
AccessibleTopology: Schema.optionalWith<Schema.Array$<Schema.NullOr<typeof VolumeTopology.VolumeTopology>>, {
nullable: true;
}>;
}, Schema.Struct.Encoded<{
/**
* CapacityBytes is the capacity of the volume in bytes. A value of 0
* indicates that the capacity is unknown.
*/
CapacityBytes: Schema.optional<MobySchemas.Int64Schemas.$Int64>;
/**
* VolumeContext is the context originating from the CSI storage plugin
* when the Volume is created.
*/
VolumeContext: Schema.optionalWith<Schema.Record$<typeof Schema.String, typeof Schema.String>, {
nullable: true;
}>;
/**
* VolumeID is the ID of the Volume as seen by the CSI storage plugin.
* This is distinct from the Volume's Swarm ID, which is the ID used by
* all of the Docker Engine to refer to the Volume. If this field is
* blank, then the Volume has not been successfully created yet.
*/
VolumeID: Schema.optional<typeof Schema.String>;
/**
* AccessibleTopology is the topology this volume is actually accessible
* from.
*/
AccessibleTopology: Schema.optionalWith<Schema.Array$<Schema.NullOr<typeof VolumeTopology.VolumeTopology>>, {
nullable: true;
}>;
}>, never, {
readonly CapacityBytes?: MobySchemas.Int64Schemas.Int64Brand | undefined;
} & {
readonly VolumeContext?: {
readonly [x: string]: string;
} | undefined;
} & {
readonly VolumeID?: string | undefined;
} & {
readonly AccessibleTopology?: readonly (VolumeTopology.VolumeTopology | null)[] | undefined;
}, {}, {}>;
export declare class VolumeInfo extends VolumeInfo_base {
}
export {};
//# sourceMappingURL=VolumeInfo.generated.d.ts.map