Resource URL: /platform/<<version=5>>/protocols/hdfs/inotify/settings

    Overview: This resource applies the HDFS INotify settings.

     Methods: GET, PUT

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

Method GET: Retrieve HDFS INotify properties.

       URL: GET /platform/<<version=5>>/protocols/hdfs/inotify/settings

Query arguments:
zone=<string> Access zone which contains INotify settings.

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"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "settings": {
          "type": "object", 
          "description": "Settings for HDFS INotify.", 
          "properties": {
            "maximum_delay": {
              "required": false, 
              "minimum": 0, 
              "type": "integer", 
              "description": "The maximum duration in seconds until an edit event is reported in INotify. The default is 60, which amounts to a minute.", 
              "maximum": 2147483647
            }, 
            "enabled": {
              "required": false, 
              "type": "boolean", 
              "description": "Enable or disable the collection of edits over HDFS and access to the edits via HDFS INotify stream."
            }, 
            "retention": {
              "required": false, 
              "minimum": 0, 
              "type": "integer", 
              "description": "The minimum amount of time in seconds the edits will be retained. The default is 172800, which amounts to 48hr.", 
              "maximum": 2147483647
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Modify HDFS INotify properties.

       URL: PUT /platform/<<version=5>>/protocols/hdfs/inotify/settings

Query arguments:
zone=<string> Access zone which contains INotify settings.

PUT request body schema:
{
  "type": "object", 
  "description": "Settings for HDFS INotify.", 
  "properties": {
    "maximum_delay": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "required": false, 
          "minimum": 0, 
          "type": "integer", 
          "description": "The maximum duration in seconds until an edit event is reported in INotify. The default is 60, which amounts to a minute.", 
          "maximum": 2147483647
        }
      ]
    }, 
    "enabled": {
      "required": false, 
      "type": "boolean", 
      "description": "Enable or disable the collection of edits over HDFS and access to the edits via HDFS INotify stream."
    }, 
    "retention": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "required": false, 
          "minimum": 0, 
          "type": "integer", 
          "description": "The minimum amount of time in seconds the edits will be retained. The default is 172800, which amounts to 48hr.", 
          "maximum": 2147483647
        }
      ]
    }
  }
}

There is no JSON response body for this method.
