@metal-stack/api 0.4.3 → 0.5.1

package/{js/metalstack → metalstack}/admin/v2/switch_pb.ts

@@ -29,7 +29,7 @@ export const file_metalstack_admin_v2_switch: GenFile = /*@__PURE__*/
  */
 export type SwitchServiceGetRequest = Message<"metalstack.admin.v2.SwitchServiceGetRequest"> & {
   /**
-   * Id of the switch to get
+   * Id of the switch to get.
    *
    * @generated from field: string id = 1;
    */
@@ -50,7 +50,7 @@ export const SwitchServiceGetRequestSchema: GenMessage<SwitchServiceGetRequest>
  */
 export type SwitchServiceGetResponse = Message<"metalstack.admin.v2.SwitchServiceGetResponse"> & {
   /**
-   * Switch contains the requested switch
+   * Switch contains the requested switch.
    *
    * @generated from field: metalstack.api.v2.Switch switch = 1;
    */
@@ -71,7 +71,7 @@ export const SwitchServiceGetResponseSchema: GenMessage<SwitchServiceGetResponse
  */
 export type SwitchServiceListRequest = Message<"metalstack.admin.v2.SwitchServiceListRequest"> & {
   /**
-   * Query to filter the results
+   * Query to filter the results.
    *
    * @generated from field: metalstack.api.v2.SwitchQuery query = 1;
    */
@@ -92,7 +92,7 @@ export const SwitchServiceListRequestSchema: GenMessage<SwitchServiceListRequest
  */
 export type SwitchServiceListResponse = Message<"metalstack.admin.v2.SwitchServiceListResponse"> & {
   /**
-   * Switches that match the request query
+   * Switches that match the request query.
    *
    * @generated from field: repeated metalstack.api.v2.Switch switches = 1;
    */
@@ -113,71 +113,71 @@ export const SwitchServiceListResponseSchema: GenMessage<SwitchServiceListRespon
  */
 export type SwitchServiceUpdateRequest = Message<"metalstack.admin.v2.SwitchServiceUpdateRequest"> & {
   /**
-   * ID of the switch
+   * ID of the switch.
    *
    * @generated from field: string id = 1;
    */
   id: string;
 
   /**
-   * UpdateMeta contains the timestamp and strategy to be used in this update request
+   * UpdateMeta contains the timestamp and strategy to be used in this update request.
    *
    * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2;
    */
   updateMeta?: UpdateMeta | undefined;
 
   /**
-   * UpdatedAt is the date when this entity was updated
-   * Must be part of the update request to ensure optimistic locking
+   * UpdatedAt is the date when this entity was updated.
+   * Must be part of the update request to ensure optimistic locking.
    *
    * @generated from field: google.protobuf.Timestamp updated_at = 3;
    */
   updatedAt?: Timestamp | undefined;
 
   /**
-   * Description of the switch
+   * Description of the switch.
    *
    * @generated from field: optional string description = 4;
    */
   description?: string | undefined;
 
   /**
-   * ReplaceMode is used to mark a switch ready for replacement
+   * ReplaceMode is used to mark a switch ready for replacement.
    *
    * @generated from field: optional metalstack.api.v2.SwitchReplaceMode replace_mode = 5;
    */
   replaceMode?: SwitchReplaceMode | undefined;
 
   /**
-   * ManagementIp is the switch's IP for management access
+   * ManagementIp is the switch's IP for management access.
    *
    * @generated from field: optional string management_ip = 6;
    */
   managementIp?: string | undefined;
 
   /**
-   * ManagementUser is the user name to use for management access
+   * ManagementUser is the user name to use for management access.
    *
    * @generated from field: optional string management_user = 7;
    */
   managementUser?: string | undefined;
 
   /**
-   * ConsoleCommand is the command for accessing the switch's console
+   * ConsoleCommand is the command for accessing the switch's console.
    *
    * @generated from field: optional string console_command = 8;
    */
   consoleCommand?: string | undefined;
 
   /**
-   * Nics are the front panel ports of the switch
+   * Nics are the front panel ports of the switch.
    *
    * @generated from field: repeated metalstack.api.v2.SwitchNic nics = 9;
    */
   nics: SwitchNic[];
 
   /**
-   * SwitchOs is the OS running on the switch
+   * SwitchOs is the OS running on the switch.
    *
    * @generated from field: optional metalstack.api.v2.SwitchOS os = 10;
    */
@@ -198,7 +198,7 @@ export const SwitchServiceUpdateRequestSchema: GenMessage<SwitchServiceUpdateReq
  */
 export type SwitchServiceUpdateResponse = Message<"metalstack.admin.v2.SwitchServiceUpdateResponse"> & {
   /**
-   * Switch contains the updated switch
+   * Switch contains the updated switch.
    *
    * @generated from field: metalstack.api.v2.Switch switch = 1;
    */
@@ -219,14 +219,14 @@ export const SwitchServiceUpdateResponseSchema: GenMessage<SwitchServiceUpdateRe
  */
 export type SwitchServiceDeleteRequest = Message<"metalstack.admin.v2.SwitchServiceDeleteRequest"> & {
   /**
-   * Id of the switch
+   * Id of the switch.
    *
    * @generated from field: string id = 1;
    */
   id: string;
 
   /**
-   * Force will allow switch deletion despite existing machine connections
+   * Force will allow switch deletion despite existing machine connections.
    *
    * @generated from field: bool force = 2;
    */
@@ -247,7 +247,7 @@ export const SwitchServiceDeleteRequestSchema: GenMessage<SwitchServiceDeleteReq
  */
 export type SwitchServiceDeleteResponse = Message<"metalstack.admin.v2.SwitchServiceDeleteResponse"> & {
   /**
-   * Switch contains the deleted switch
+   * Switch contains the deleted switch.
    *
    * @generated from field: metalstack.api.v2.Switch switch = 1;
    */
@@ -268,14 +268,14 @@ export const SwitchServiceDeleteResponseSchema: GenMessage<SwitchServiceDeleteRe
  */
 export type SwitchServiceMigrateRequest = Message<"metalstack.admin.v2.SwitchServiceMigrateRequest"> & {
   /**
-   * OldSwitch is the switch to migrate away from
+   * OldSwitch is the switch to migrate away from.
    *
    * @generated from field: string old_switch = 1;
    */
   oldSwitch: string;
 
   /**
-   * NewSwitch is the switch to migrate to
+   * NewSwitch is the switch to migrate to.
    *
    * @generated from field: string new_switch = 2;
    */
@@ -296,7 +296,7 @@ export const SwitchServiceMigrateRequestSchema: GenMessage<SwitchServiceMigrateR
  */
 export type SwitchServiceMigrateResponse = Message<"metalstack.admin.v2.SwitchServiceMigrateResponse"> & {
   /**
-   * Switch contains the switch that was migrated to
+   * Switch contains the switch that was migrated to.
    *
    * @generated from field: metalstack.api.v2.Switch switch = 1;
    */
@@ -317,21 +317,21 @@ export const SwitchServiceMigrateResponseSchema: GenMessage<SwitchServiceMigrate
  */
 export type SwitchServicePortRequest = Message<"metalstack.admin.v2.SwitchServicePortRequest"> & {
   /**
-   * Id of the switch
+   * Id of the switch.
    *
    * @generated from field: string id = 1;
    */
   id: string;
 
   /**
-   * NicName of the port whose status should be changed
+   * NicName of the port whose status should be changed.
    *
    * @generated from field: string nic_name = 2;
    */
   nicName: string;
 
   /**
-   * Status that the port should have
+   * Status that the port should have.
    *
    * @generated from field: metalstack.api.v2.SwitchPortStatus status = 3;
    */
@@ -352,7 +352,7 @@ export const SwitchServicePortRequestSchema: GenMessage<SwitchServicePortRequest
  */
 export type SwitchServicePortResponse = Message<"metalstack.admin.v2.SwitchServicePortResponse"> & {
   /**
-   * Switch after the port status toggle
+   * Switch after the port status toggle.
    *
    * @generated from field: metalstack.api.v2.Switch switch = 1;
    */
@@ -373,14 +373,14 @@ export const SwitchServicePortResponseSchema: GenMessage<SwitchServicePortRespon
  */
 export type SwitchServiceConnectedMachinesRequest = Message<"metalstack.admin.v2.SwitchServiceConnectedMachinesRequest"> & {
   /**
-   * Query to filter the switch results
+   * Query to filter the switch results.
    *
    * @generated from field: metalstack.api.v2.SwitchQuery query = 1;
    */
   query?: SwitchQuery | undefined;
 
   /**
-   * MachineQuery to filter the machine results
+   * MachineQuery to filter the machine results.
    *
    * @generated from field: metalstack.api.v2.MachineQuery machine_query = 2;
    */
@@ -401,7 +401,7 @@ export const SwitchServiceConnectedMachinesRequestSchema: GenMessage<SwitchServi
  */
 export type SwitchServiceConnectedMachinesResponse = Message<"metalstack.admin.v2.SwitchServiceConnectedMachinesResponse"> & {
   /**
-   * SwitchesWithMachines contains all switches with their machine connections
+   * SwitchesWithMachines contains all switches with their machine connections.
    *
    * @generated from field: repeated metalstack.api.v2.SwitchWithMachines switches_with_machines = 1;
    */

package/{js/metalstack → metalstack}/admin/v2/task_pb.d.ts

@@ -12,13 +12,13 @@ export declare const file_metalstack_admin_v2_task: GenFile;
  */
 export type TaskServiceGetRequest = Message<"metalstack.admin.v2.TaskServiceGetRequest"> & {
     /**
-     * TaskId is the identifier of the task to get
+     * TaskId is the identifier of the task to get.
      *
      * @generated from field: string task_id = 1;
      */
     taskId: string;
     /**
-     * Queue is the queue where this task was scheduled to
+     * Queue is the queue where this task was scheduled to.
      *
      * @generated from field: string queue = 2;
      */
@@ -36,7 +36,7 @@ export declare const TaskServiceGetRequestSchema: GenMessage<TaskServiceGetReque
  */
 export type TaskServiceGetResponse = Message<"metalstack.admin.v2.TaskServiceGetResponse"> & {
     /**
-     * Task contains the task details
+     * Task contains the task details.
      *
      * @generated from field: metalstack.admin.v2.TaskInfo task = 1;
      */
@@ -54,13 +54,13 @@ export declare const TaskServiceGetResponseSchema: GenMessage<TaskServiceGetResp
  */
 export type TaskServiceDeleteRequest = Message<"metalstack.admin.v2.TaskServiceDeleteRequest"> & {
     /**
-     * TaskId is the identifier of the task to cancel
+     * TaskId is the identifier of the task to cancel.
      *
      * @generated from field: string task_id = 1;
      */
     taskId: string;
     /**
-     * Queue is the queue where this task was scheduled to
+     * Queue is the queue where this task was scheduled to.
      *
      * @generated from field: string queue = 2;
      */
@@ -100,7 +100,7 @@ export declare const TaskServiceQueuesRequestSchema: GenMessage<TaskServiceQueue
  */
 export type TaskServiceQueuesResponse = Message<"metalstack.admin.v2.TaskServiceQueuesResponse"> & {
     /**
-     * Queues configured for the async system
+     * Queues configured for the async system.
      *
      * @generated from field: repeated string queues = 1;
      */
@@ -118,20 +118,20 @@ export declare const TaskServiceQueuesResponseSchema: GenMessage<TaskServiceQueu
  */
 export type TaskServiceListRequest = Message<"metalstack.admin.v2.TaskServiceListRequest"> & {
     /**
-     * Queue filters tasks by this queue
-     * Will return tasks from all queues if not specified
+     * Queue filters tasks by this queue.
+     * Will return tasks from all queues if not specified.
      *
      * @generated from field: optional string queue = 1;
      */
     queue?: string | undefined;
     /**
-     * Count is the number of tasks to return
+     * Count is the number of tasks to return.
      *
      * @generated from field: optional uint32 count = 2;
      */
     count?: number | undefined;
     /**
-     * Page is the page of tasks to return
+     * Page is the page of tasks to return.
      *
      * @generated from field: optional uint32 page = 3;
      */
@@ -149,7 +149,7 @@ export declare const TaskServiceListRequestSchema: GenMessage<TaskServiceListReq
  */
 export type TaskServiceListResponse = Message<"metalstack.admin.v2.TaskServiceListResponse"> & {
     /**
-     * Tasks contains the list of requested tasks
+     * Tasks contains the list of requested tasks.
      *
      * @generated from field: repeated metalstack.admin.v2.TaskInfo tasks = 1;
      */
@@ -167,117 +167,117 @@ export declare const TaskServiceListResponseSchema: GenMessage<TaskServiceListRe
  */
 export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & {
     /**
-     * ID is the identifier of the task
+     * ID is the identifier of the task.
      *
      * @generated from field: string id = 1;
      */
     id: string;
     /**
-     * Queue is the name of the queue in which the task belongs
+     * Queue is the name of the queue in which the task belongs.
      *
      * @generated from field: string queue = 2;
      */
     queue: string;
     /**
-     * Type is the type name of the task
+     * Type is the type name of the task.
      *
      * @generated from field: string type = 3;
      */
     type: string;
     /**
-     * Payload is the payload data of the task
+     * Payload is the payload data of the task.
      *
      * @generated from field: bytes payload = 4;
      */
     payload: Uint8Array;
     /**
-     * State indicates the task state
+     * State indicates the task state.
      *
      * @generated from field: metalstack.admin.v2.TaskState state = 5;
      */
     state: TaskState;
     /**
-     * MaxRetry is the maximum number of times the task can be retried
+     * MaxRetry is the maximum number of times the task can be retried.
      *
      * @generated from field: int32 max_retry = 6;
      */
     maxRetry: number;
     /**
-     * Retried is the number of times the task has retried so far
+     * Retried is the number of times the task has retried so far.
      *
      * @generated from field: int32 retried = 7;
      */
     retried: number;
     /**
-     * LastError is the error message from the last failure
+     * LastError is the error message from the last failure.
      *
      * @generated from field: string last_error = 8;
      */
     lastError: string;
     /**
-     * LastFailedAt is the time of the last failure if any
-     * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{})
+     * LastFailedAt is the time of the last failure if any.
+     * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}).
      *
      * @generated from field: google.protobuf.Timestamp last_failed_at = 9;
      */
     lastFailedAt?: Timestamp | undefined;
     /**
-     * Timeout is the duration the task can be processed by Handler before being retried
+     * Timeout is the duration the task can be processed by Handler before being retried.
      *
      * @generated from field: google.protobuf.Duration timeout = 10;
      */
     timeout?: Duration | undefined;
     /**
-     * Deadline is the deadline for the task
+     * Deadline is the deadline for the task.
      *
      * @generated from field: google.protobuf.Timestamp deadline = 11;
      */
     deadline?: Timestamp | undefined;
     /**
-     * Group is the name of the group in which the task belongs
+     * Group is the name of the group in which the task belongs.
      *
-     * Tasks in the same queue can be grouped together by Group name and will be aggregated into one task
-     * by a Server processing the queue
+     * Tasks in the same queue can be grouped together by Group name and will be aggregated into one task.
+     * by a Server processing the queue.
      *
-     * Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task
+     * Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task.
      *
      * @generated from field: string group = 12;
      */
     group: string;
     /**
-     * NextProcessAt is the time the task is scheduled to be processed
-     * Zero if not applicable
+     * NextProcessAt is the time the task is scheduled to be processed.
+     * Zero if not applicable.
      *
      * @generated from field: google.protobuf.Timestamp next_process_at = 13;
      */
     nextProcessAt?: Timestamp | undefined;
     /**
-     * IsOrphaned describes whether the task is left in active state with no worker processing it
-     * An orphaned task indicates that the worker has crashed or experienced network failures and was not able to
-     * extend its lease on the task
+     * IsOrphaned describes whether the task is left in active state with no worker processing it.
+     * An orphaned task indicates that the worker has crashed or experienced network failures and was not able to.
+     * extend its lease on the task.
      *
-     * This task will be recovered by running a server against the queue the task is in
-     * This field is only applicable to tasks with TaskStateActive
+     * This task will be recovered by running a server against the queue the task is in.
+     * This field is only applicable to tasks with TaskStateActive.
      *
      * @generated from field: bool is_orphaned = 14;
      */
     isOrphaned: boolean;
     /**
-     * Retention is duration of the retention period after the task is successfully processed
+     * Retention is duration of the retention period after the task is successfully processed.
      *
      * @generated from field: google.protobuf.Duration retention = 15;
      */
     retention?: Duration | undefined;
     /**
-     * CompletedAt is the time when the task is processed successfully
-     * Zero value (i.e. time.Time{}) indicates no value
+     * CompletedAt is the time when the task is processed successfully.
+     * Zero value (i.e. time.Time{}) indicates no value.
      *
      * @generated from field: google.protobuf.Timestamp completed_at = 16;
      */
     completedAt?: Timestamp | undefined;
     /**
-     * Result holds the result data associated with the task
-     * Use ResultWriter to write result data from the Handler
+     * Result holds the result data associated with the task.
+     * Use ResultWriter to write result data from the Handler.
      *
      * @generated from field: bytes result = 17;
      */
@@ -295,49 +295,49 @@ export declare const TaskInfoSchema: GenMessage<TaskInfo>;
  */
 export declare enum TaskState {
     /**
-     * TASK_STATE_UNSPECIFIED is not specified
+     * TASK_STATE_UNSPECIFIED is not specified.
      *
      * @generated from enum value: TASK_STATE_UNSPECIFIED = 0;
      */
     UNSPECIFIED = 0,
     /**
-     * TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler
+     * TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler.
      *
      * @generated from enum value: TASK_STATE_ACTIVE = 1;
      */
     ACTIVE = 1,
     /**
-     * TASK_STATE_PENDING indicates that the task is ready to be processed by Handler
+     * TASK_STATE_PENDING indicates that the task is ready to be processed by Handler.
      *
      * @generated from enum value: TASK_STATE_PENDING = 2;
      */
     PENDING = 2,
     /**
-     * TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future
+     * TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future.
      *
      * @generated from enum value: TASK_STATE_SCHEDULED = 3;
      */
     SCHEDULED = 3,
     /**
-     * TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future
+     * TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future.
      *
      * @generated from enum value: TASK_STATE_RETRY = 4;
      */
     RETRY = 4,
     /**
-     * TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes
+     * TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes.
      *
      * @generated from enum value: TASK_STATE_ARCHIVED = 5;
      */
     ARCHIVED = 5,
     /**
-     * TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires
+     * TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires.
      *
      * @generated from enum value: TASK_STATE_COMPLETED = 6;
      */
     COMPLETED = 6,
     /**
-     * TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task
+     * TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task.
      *
      * @generated from enum value: TASK_STATE_AGGREGATING = 7;
      */

package/{js/metalstack → metalstack}/admin/v2/task_pb.js

@@ -61,49 +61,49 @@ export const TaskInfoSchema = /*@__PURE__*/ messageDesc(file_metalstack_admin_v2
 export var TaskState;
 (function (TaskState) {
     /**
-     * TASK_STATE_UNSPECIFIED is not specified
+     * TASK_STATE_UNSPECIFIED is not specified.
      *
      * @generated from enum value: TASK_STATE_UNSPECIFIED = 0;
      */
     TaskState[TaskState["UNSPECIFIED"] = 0] = "UNSPECIFIED";
     /**
-     * TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler
+     * TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler.
      *
      * @generated from enum value: TASK_STATE_ACTIVE = 1;
      */
     TaskState[TaskState["ACTIVE"] = 1] = "ACTIVE";
     /**
-     * TASK_STATE_PENDING indicates that the task is ready to be processed by Handler
+     * TASK_STATE_PENDING indicates that the task is ready to be processed by Handler.
      *
      * @generated from enum value: TASK_STATE_PENDING = 2;
      */
     TaskState[TaskState["PENDING"] = 2] = "PENDING";
     /**
-     * TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future
+     * TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future.
      *
      * @generated from enum value: TASK_STATE_SCHEDULED = 3;
      */
     TaskState[TaskState["SCHEDULED"] = 3] = "SCHEDULED";
     /**
-     * TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future
+     * TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future.
      *
      * @generated from enum value: TASK_STATE_RETRY = 4;
      */
     TaskState[TaskState["RETRY"] = 4] = "RETRY";
     /**
-     * TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes
+     * TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes.
      *
      * @generated from enum value: TASK_STATE_ARCHIVED = 5;
      */
     TaskState[TaskState["ARCHIVED"] = 5] = "ARCHIVED";
     /**
-     * TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires
+     * TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires.
      *
      * @generated from enum value: TASK_STATE_COMPLETED = 6;
      */
     TaskState[TaskState["COMPLETED"] = 6] = "COMPLETED";
     /**
-     * TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task
+     * TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task.
      *
      * @generated from enum value: TASK_STATE_AGGREGATING = 7;
      */