@metal-stack/api 0.4.4 → 0.5.2

package/{js/metalstack → metalstack}/api/v2/filesystem_pb.d.ts

@@ -6,13 +6,13 @@ import type { Message } from "@bufbuild/protobuf";
  */
 export declare const file_metalstack_api_v2_filesystem: GenFile;
 /**
- * FilesystemServiceGetRequest is the request payload for a filesystem get request
+ * FilesystemServiceGetRequest is the request payload for a filesystem get request.
  *
  * @generated from message metalstack.api.v2.FilesystemServiceGetRequest
  */
 export type FilesystemServiceGetRequest = Message<"metalstack.api.v2.FilesystemServiceGetRequest"> & {
     /**
-     * ID of the filesystem to get
+     * ID of the filesystem to get.
      *
      * @generated from field: string id = 1;
      */
@@ -24,13 +24,13 @@ export type FilesystemServiceGetRequest = Message<"metalstack.api.v2.FilesystemS
  */
 export declare const FilesystemServiceGetRequestSchema: GenMessage<FilesystemServiceGetRequest>;
 /**
- * FilesystemServiceListRequest is the request payload for a filesystem list request
+ * FilesystemServiceListRequest is the request payload for a filesystem list request.
  *
  * @generated from message metalstack.api.v2.FilesystemServiceListRequest
  */
 export type FilesystemServiceListRequest = Message<"metalstack.api.v2.FilesystemServiceListRequest"> & {
     /**
-     * ID of the filesystem to get
+     * ID of the filesystem to get.
      *
      * @generated from field: optional string id = 1;
      */
@@ -42,13 +42,13 @@ export type FilesystemServiceListRequest = Message<"metalstack.api.v2.Filesystem
  */
 export declare const FilesystemServiceListRequestSchema: GenMessage<FilesystemServiceListRequest>;
 /**
- * FilesystemServiceGetResponse is the response payload for a filesystem get request
+ * FilesystemServiceGetResponse is the response payload for a filesystem get request.
  *
  * @generated from message metalstack.api.v2.FilesystemServiceGetResponse
  */
 export type FilesystemServiceGetResponse = Message<"metalstack.api.v2.FilesystemServiceGetResponse"> & {
     /**
-     * FilesystemLayout the filesystemlayout
+     * FilesystemLayout the filesystemlayout.
      *
      * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1;
      */
@@ -60,13 +60,13 @@ export type FilesystemServiceGetResponse = Message<"metalstack.api.v2.Filesystem
  */
 export declare const FilesystemServiceGetResponseSchema: GenMessage<FilesystemServiceGetResponse>;
 /**
- * FilesystemServiceListResponse is the response payload for a filesystem list request
+ * FilesystemServiceListResponse is the response payload for a filesystem list request.
  *
  * @generated from message metalstack.api.v2.FilesystemServiceListResponse
  */
 export type FilesystemServiceListResponse = Message<"metalstack.api.v2.FilesystemServiceListResponse"> & {
     /**
-     * FilesystemLayouts the filesystemlayouts
+     * FilesystemLayouts the filesystemlayouts.
      *
      * @generated from field: repeated metalstack.api.v2.FilesystemLayout filesystem_layouts = 1;
      */
@@ -78,67 +78,67 @@ export type FilesystemServiceListResponse = Message<"metalstack.api.v2.Filesyste
  */
 export declare const FilesystemServiceListResponseSchema: GenMessage<FilesystemServiceListResponse>;
 /**
- * FilesystemLayout
+ * FilesystemLayout.
  *
  * @generated from message metalstack.api.v2.FilesystemLayout
  */
 export type FilesystemLayout = Message<"metalstack.api.v2.FilesystemLayout"> & {
     /**
-     * Id of this filesystemLayout
+     * Id of this filesystemLayout.
      *
      * @generated from field: string id = 1;
      */
     id: string;
     /**
-     * Meta for this filesystemLayout
+     * Meta for this filesystemLayout.
      *
      * @generated from field: metalstack.api.v2.Meta meta = 2;
      */
     meta?: Meta | undefined;
     /**
-     * Name of this filesystemLayout
+     * Name of this filesystemLayout.
      *
      * @generated from field: optional string name = 3;
      */
     name?: string | undefined;
     /**
-     * Description of this filesystemLayout
+     * Description of this filesystemLayout.
      *
      * @generated from field: optional string description = 4;
      */
     description?: string | undefined;
     /**
-     * Filesystems is a list of filesystems to create on a machine
+     * Filesystems is a list of filesystems to create on a machine.
      *
      * @generated from field: repeated metalstack.api.v2.Filesystem filesystems = 5;
      */
     filesystems: Filesystem[];
     /**
-     * Disks list of disks that belong to this layout
+     * Disks list of disks that belong to this layout.
      *
      * @generated from field: repeated metalstack.api.v2.Disk disks = 6;
      */
     disks: Disk[];
     /**
-     * raid arrays to create
+     * Raid arrays to create.
      *
      * @generated from field: repeated metalstack.api.v2.Raid raid = 7;
      */
     raid: Raid[];
     /**
-     * VolumeGroups list of volumegroups to create
+     * VolumeGroups list of volumegroups to create.
      *
      * @generated from field: repeated metalstack.api.v2.VolumeGroup volume_groups = 8;
      */
     volumeGroups: VolumeGroup[];
     /**
-     * LogicalVolumes list of logicalvolumes to create
+     * LogicalVolumes list of logicalvolumes to create.
      *
      * @generated from field: repeated metalstack.api.v2.LogicalVolume logical_volumes = 9;
      */
     logicalVolumes: LogicalVolume[];
     /**
-     * Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts
+     * Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts.
      *
      * @generated from field: metalstack.api.v2.FilesystemLayoutConstraints constraints = 10;
      */
@@ -150,24 +150,24 @@ export type FilesystemLayout = Message<"metalstack.api.v2.FilesystemLayout"> & {
  */
 export declare const FilesystemLayoutSchema: GenMessage<FilesystemLayout>;
 /**
- * FilesystemLayoutConstraints
+ * FilesystemLayoutConstraints.
  *
  * @generated from message metalstack.api.v2.FilesystemLayoutConstraints
  */
 export type FilesystemLayoutConstraints = Message<"metalstack.api.v2.FilesystemLayoutConstraints"> & {
     /**
-     * Sizes list of sizes this layout applies to
-     * this could either be a concrete size, or a asterisk to match all sizes
+     * Sizes list of sizes this layout applies to.
+     * This could either be a concrete size, or a asterisk to match all sizes.
      *
      * @generated from field: repeated string sizes = 1;
      */
     sizes: string[];
     /**
-     * Images list of images this layout applies to in the following form
-     * key must be the first part of available images, e.g. the name of the image
-     * value must be a semver match expression with the constraint and the version separated by space
-     * this would match all debian images which are greater or equal 12.0
-     * "debian":">= 12.0"
+     * Images list of images this layout applies to in the following form:
+     * Key must be the first part of available images, e.g. the name of the imag.
+     * Value must be a semver match expression with the constraint and the version separated by space.
+     * This would match all debian images which are greater or equal 12:
+     * "debian": >= 12.0.
      *
      * @generated from field: map<string, string> images = 2;
      */
@@ -181,55 +181,55 @@ export type FilesystemLayoutConstraints = Message<"metalstack.api.v2.FilesystemL
  */
 export declare const FilesystemLayoutConstraintsSchema: GenMessage<FilesystemLayoutConstraints>;
 /**
- * Filesystem
+ * Filesystem.
  *
  * @generated from message metalstack.api.v2.Filesystem
  */
 export type Filesystem = Message<"metalstack.api.v2.Filesystem"> & {
     /**
-     * Device the underlying device where this filesystem should be created
+     * Device the underlying device where this filesystem should be created.
      *
      * @generated from field: string device = 1;
      */
     device: string;
     /**
-     * Format of the filesystem format
+     * Format of the filesystem format.
      *
      * @generated from field: metalstack.api.v2.Format format = 2;
      */
     format: Format;
     /**
-     * Name of this filesystem
+     * Name of this filesystem.
      *
      * @generated from field: optional string name = 3;
      */
     name?: string | undefined;
     /**
-     * Description of this filesystem
+     * Description of this filesystem.
      *
      * @generated from field: optional string description = 4;
      */
     description?: string | undefined;
     /**
-     * Path the mountpoint where this filesystem should be mounted on
+     * Path the mountpoint where this filesystem should be mounted on.
      *
      * @generated from field: optional string path = 5;
      */
     path?: string | undefined;
     /**
-     * Label an optional label for this filesystem
+     * Label an optional label for this filesystem.
      *
      * @generated from field: optional string label = 6;
      */
     label?: string | undefined;
     /**
-     * MountOptions the options to use to mount this filesystem
+     * MountOptions the options to use to mount this filesystem.
      *
      * @generated from field: repeated string mount_options = 7;
      */
     mountOptions: string[];
     /**
-     * CreateOptions the options to use to create (mkfs) this filesystem
+     * CreateOptions the options to use to create (mkfs) this filesystem.
      *
      * @generated from field: repeated string create_options = 8;
      */
@@ -241,19 +241,19 @@ export type Filesystem = Message<"metalstack.api.v2.Filesystem"> & {
  */
 export declare const FilesystemSchema: GenMessage<Filesystem>;
 /**
- * Disk
+ * Disk.
  *
  * @generated from message metalstack.api.v2.Disk
  */
 export type Disk = Message<"metalstack.api.v2.Disk"> & {
     /**
-     * Device the device to create the partitions
+     * Device the device to create the partitions.
      *
      * @generated from field: string device = 1;
      */
     device: string;
     /**
-     * Partitions list of partitions to create on this disk
+     * Partitions list of partitions to create on this disk.
      *
      * @generated from field: repeated metalstack.api.v2.DiskPartition partitions = 2;
      */
@@ -265,37 +265,37 @@ export type Disk = Message<"metalstack.api.v2.Disk"> & {
  */
 export declare const DiskSchema: GenMessage<Disk>;
 /**
- * Raid
+ * Raid.
  *
  * @generated from message metalstack.api.v2.Raid
  */
 export type Raid = Message<"metalstack.api.v2.Raid"> & {
     /**
-     * ArrayName the name of the resulting array device
+     * ArrayName the name of the resulting array device.
      *
      * @generated from field: string array_name = 1;
      */
     arrayName: string;
     /**
-     * Devices list of devices to form the raid array from
+     * Devices list of devices to form the raid array from.
      *
      * @generated from field: repeated string devices = 2;
      */
     devices: string[];
     /**
-     * Level raid level to create, should be 0 or 1
+     * Level raid level to create, should be 0 or 1.
      *
      * @generated from field: metalstack.api.v2.RaidLevel level = 3;
      */
     level: RaidLevel;
     /**
-     * CreateOptions the options to use to create the raid array
+     * CreateOptions the options to use to create the raid array.
      *
      * @generated from field: repeated string create_options = 4;
      */
     createOptions: string[];
     /**
-     * Spares number of spares for the raid array
+     * Spares number of spares for the raid array.
      *
      * @generated from field: int32 spares = 5;
      */
@@ -307,31 +307,31 @@ export type Raid = Message<"metalstack.api.v2.Raid"> & {
  */
 export declare const RaidSchema: GenMessage<Raid>;
 /**
- * DiskPartition
+ * DiskPartition.
  *
  * @generated from message metalstack.api.v2.DiskPartition
  */
 export type DiskPartition = Message<"metalstack.api.v2.DiskPartition"> & {
     /**
-     * Number partition number, will be appended to partitionprefix to create the final devicename
+     * Number partition number, will be appended to partitionprefix to create the final devicename.
      *
      * @generated from field: uint32 number = 1;
      */
     number: number;
     /**
-     * Label an optional label for this partition
+     * Label an optional label for this partition.
      *
      * @generated from field: optional string label = 2;
      */
     label?: string | undefined;
     /**
-     * Size in mebibytes (MiB) of this partition
+     * Size in mebibytes (MiB) of this partition.
      *
      * @generated from field: uint64 size = 3;
      */
     size: bigint;
     /**
-     * GPTType the gpt partition table type of this partition
+     * GPTType the gpt partition table type of this partition.
      *
      * @generated from field: optional metalstack.api.v2.GPTType gpt_type = 4;
      */
@@ -343,25 +343,25 @@ export type DiskPartition = Message<"metalstack.api.v2.DiskPartition"> & {
  */
 export declare const DiskPartitionSchema: GenMessage<DiskPartition>;
 /**
- * VolumeGroup
+ * VolumeGroup.
  *
  * @generated from message metalstack.api.v2.VolumeGroup
  */
 export type VolumeGroup = Message<"metalstack.api.v2.VolumeGroup"> & {
     /**
-     * Name the name of the resulting volume group
+     * Name the name of the resulting volume group.
      *
      * @generated from field: string name = 1;
      */
     name: string;
     /**
-     * Devices list of devices to form the volume group from
+     * Devices list of devices to form the volume group from.
      *
      * @generated from field: repeated string devices = 2;
      */
     devices: string[];
     /**
-     * Tags list of tags to add to the volume group
+     * Tags list of tags to add to the volume group.
      *
      * @generated from field: repeated string tags = 3;
      */
@@ -373,31 +373,31 @@ export type VolumeGroup = Message<"metalstack.api.v2.VolumeGroup"> & {
  */
 export declare const VolumeGroupSchema: GenMessage<VolumeGroup>;
 /**
- * LogicalVolume
+ * LogicalVolume.
  *
  * @generated from message metalstack.api.v2.LogicalVolume
  */
 export type LogicalVolume = Message<"metalstack.api.v2.LogicalVolume"> & {
     /**
-     * Name the name of the logical volume
+     * Name the name of the logical volume.
      *
      * @generated from field: string name = 1;
      */
     name: string;
     /**
-     * VolumeGroup the name of the volume group where to create the logical volume onto
+     * VolumeGroup the name of the volume group where to create the logical volume onto.
      *
      * @generated from field: string volume_group = 2;
      */
     volumeGroup: string;
     /**
-     * Size size in mebibytes (MiB) of this volume
+     * Size size in mebibytes (MiB) of this volume.
      *
      * @generated from field: uint64 size = 3;
      */
     size: bigint;
     /**
-     * LVMType the type of this logical volume can be either linear|striped|raid1
+     * LVMType the type of this logical volume can be either linear|striped|raid1.
      *
      * @generated from field: metalstack.api.v2.LVMType lvm_type = 4;
      */
@@ -409,31 +409,31 @@ export type LogicalVolume = Message<"metalstack.api.v2.LogicalVolume"> & {
  */
 export declare const LogicalVolumeSchema: GenMessage<LogicalVolume>;
 /**
- * LVMType
+ * LVMType.
  *
  * @generated from enum metalstack.api.v2.LVMType
  */
 export declare enum LVMType {
     /**
-     * LVM_TYPE_UNSPECIFIED is not specified
+     * LVM_TYPE_UNSPECIFIED is not specified.
      *
      * @generated from enum value: LVM_TYPE_UNSPECIFIED = 0;
      */
     LVM_TYPE_UNSPECIFIED = 0,
     /**
-     * LVM_TYPE_LINEAR append across all physical volumes
+     * LVM_TYPE_LINEAR append across all physical volumes.
      *
      * @generated from enum value: LVM_TYPE_LINEAR = 1;
      */
     LVM_TYPE_LINEAR = 1,
     /**
-     * LVM_TYPE_STRIPED stripe across all physical volumes
+     * LVM_TYPE_STRIPED stripe across all physical volumes.
      *
      * @generated from enum value: LVM_TYPE_STRIPED = 2;
      */
     LVM_TYPE_STRIPED = 2,
     /**
-     * LVM_TYPE_RAID1 mirror with raid across all physical volumes
+     * LVM_TYPE_RAID1 mirror with raid across all physical volumes.
      *
      * @generated from enum value: LVM_TYPE_RAID1 = 3;
      */
@@ -444,49 +444,49 @@ export declare enum LVMType {
  */
 export declare const LVMTypeSchema: GenEnum<LVMType>;
 /**
- * Format specifies the filesystem to use on a volume
+ * Format specifies the filesystem to use on a volume.
  *
  * @generated from enum metalstack.api.v2.Format
  */
 export declare enum Format {
     /**
-     * FORMAT_UNSPECIFIED
+     * FORMAT_UNSPECIFIED.
      *
      * @generated from enum value: FORMAT_UNSPECIFIED = 0;
      */
     UNSPECIFIED = 0,
     /**
-     * FORMAT_VFAT is used for the UEFI boot partition
+     * FORMAT_VFAT is used for the UEFI boot partition.
      *
      * @generated from enum value: FORMAT_VFAT = 1;
      */
     VFAT = 1,
     /**
-     * FORMAT_EXT3 is usually only used for /boot
+     * FORMAT_EXT3 is usually only used for /boot.
      *
      * @generated from enum value: FORMAT_EXT3 = 2;
      */
     EXT3 = 2,
     /**
-     * FORMAT_EXT4 is the default fs
+     * FORMAT_EXT4 is the default fs.
      *
      * @generated from enum value: FORMAT_EXT4 = 3;
      */
     EXT4 = 3,
     /**
-     * FORMAT_SWAP is for the swap partition
+     * FORMAT_SWAP is for the swap partition.
      *
      * @generated from enum value: FORMAT_SWAP = 4;
      */
     SWAP = 4,
     /**
-     * FORMAT_TMPFS is used for a memory filesystem typically /tmp
+     * FORMAT_TMPFS is used for a memory filesystem typically /tmp.
      *
      * @generated from enum value: FORMAT_TMPFS = 5;
      */
     TMPFS = 5,
     /**
-     * FORMAT_NONE
+     * FORMAT_NONE.
      *
      * @generated from enum value: FORMAT_NONE = 6;
      */
@@ -497,37 +497,37 @@ export declare enum Format {
  */
 export declare const FormatSchema: GenEnum<Format>;
 /**
- * GPTType specifies the partition type in uefi systems
+ * GPTType specifies the partition type in uefi systems.
  *
  * @generated from enum metalstack.api.v2.GPTType
  */
 export declare enum GPTType {
     /**
-     * GPT_TYPE_UNSPECIFIED is no specified
+     * GPT_TYPE_UNSPECIFIED is no specified.
      *
      * @generated from enum value: GPT_TYPE_UNSPECIFIED = 0;
      */
     GPT_TYPE_UNSPECIFIED = 0,
     /**
-     * GPT_TYPE_BOOT EFI Boot Partition
+     * GPT_TYPE_BOOT EFI Boot Partition.
      *
      * @generated from enum value: GPT_TYPE_BOOT = 1;
      */
     GPT_TYPE_BOOT = 1,
     /**
-     * GPT_TYPE_LINUX Linux Partition
+     * GPT_TYPE_LINUX Linux Partition.
      *
      * @generated from enum value: GPT_TYPE_LINUX = 2;
      */
     GPT_TYPE_LINUX = 2,
     /**
-     * GPT_TYPE_LINUX_RAID Linux Raid Partition
+     * GPT_TYPE_LINUX_RAID Linux Raid Partition.
      *
      * @generated from enum value: GPT_TYPE_LINUX_RAID = 3;
      */
     GPT_TYPE_LINUX_RAID = 3,
     /**
-     * GPT_TYPE_LINUX_LVM Linux LVM Partition
+     * GPT_TYPE_LINUX_LVM Linux LVM Partition.
      *
      * @generated from enum value: GPT_TYPE_LINUX_LVM = 4;
      */
@@ -538,25 +538,25 @@ export declare enum GPTType {
  */
 export declare const GPTTypeSchema: GenEnum<GPTType>;
 /**
- * RaidLevel defines howto mirror two or more block devices
+ * RaidLevel defines howto mirror two or more block devices.
  *
  * @generated from enum metalstack.api.v2.RaidLevel
  */
 export declare enum RaidLevel {
     /**
-     * RAID_LEVEL_UNSPECIFIED is not specified
+     * RAID_LEVEL_UNSPECIFIED is not specified.
      *
      * @generated from enum value: RAID_LEVEL_UNSPECIFIED = 0;
      */
     RAID_LEVEL_UNSPECIFIED = 0,
     /**
-     * RAID_LEVEL_0 is a stripe of two or more disks
+     * RAID_LEVEL_0 is a stripe of two or more disks.
      *
      * @generated from enum value: RAID_LEVEL_0 = 1;
      */
     RAID_LEVEL_0 = 1,
     /**
-     * RAID_LEVEL_1 is a mirror of two disks
+     * RAID_LEVEL_1 is a mirror of two disks.
      *
      * @generated from enum value: RAID_LEVEL_1 = 2;
      */