Resource URL: /platform/<<version=2>>/protocols/nfs/nlm/waiters

    Overview: This resource applies the standard collection pattern to NLM lock
              waiters on NFS.

     Methods: GET

********************************************************************************

Method GET: List all NLM lock waiters.

       URL: GET /platform/<<version=2>>/protocols/nfs/nlm/waiters

Query arguments:
  sort=<string> The field that will be used for sorting.
limit=<integer> Return no more than this many results at once (see resume).
     dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.
resume=<string> Continue returning results from previous call using this token
                (token should come from the previous call, resume cannot be
                used with other options).

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "waiters": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Information for an NLM lock on NFS.", 
            "properties": {
              "created": {
                "type": "integer", 
                "description": "Specifies the UNIX EPoch time that the lock was created."
              }, 
              "lock_type": {
                "type": "string", 
                "description": "Specifies the lock type."
              }, 
              "lin": {
                "type": "string", 
                "description": "Specifies the LIN in /ifs that is locked."
              }, 
              "range": {
                "items": {
                  "type": "integer"
                }, 
                "type": "array", 
                "description": "Specifies the byte range within the locked file."
              }, 
              "client": {
                "type": "string", 
                "description": "Specifies the client host name and IP address."
              }, 
              "client_id": {
                "type": "string", 
                "description": "Specifies the client ID."
              }, 
              "path": {
                "type": "string", 
                "description": "Specifies the path under /ifs that is locked."
              }, 
              "id": {
                "type": "string", 
                "description": "Specifies the system-assigned ID given to the lock. This value is returned when the lock is created with the POST method."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
        }
      }
    }
  ]
}
