Endpoint

/v1/file-system/settings/notify

GET

Get FS notify related settings.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "fs_notify_config",
  "type": "object",
  "properties": {
    "recursive_mode": {
      "type": "string",
      "enum": [
        "DISABLED_ERROR",
        "DISABLED_IGNORE",
        "ENABLED"
      ],
      "description": "recursive_mode:\n * `DISABLED_ERROR` - Recursive change-notify requests return errors immediately.,\n * `DISABLED_IGNORE` - The system accepts recursive change-notify requests but sends notifications only for the top directory that it watches. In other words, the system behaves as if the user doesn't specify the recursive flag. You can use this setting to improve compatibility with applications that request recursive behavior but don't actually depend on it. Important: For scenarios that require recursive behavior, this setting can cause an application to become unresponsive or exhibit other unexpected behavior.,\n * `ENABLED` - The ENABLED option is the default mode, unless you set a different one. This option provides full support for recursive change-notify requests. The system pushes notifications for all descendants of the watched directory to the watcher. Important: This configuration can affect system performance significantly. For example, watching the root of the file system creates a notification for every change on the entire cluster."
    }
  }
}

PUT

Set FS notify related settings.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "fs_notify_config",
  "type": "object",
  "properties": {
    "recursive_mode": {
      "type": "string",
      "enum": [
        "DISABLED_ERROR",
        "DISABLED_IGNORE",
        "ENABLED"
      ],
      "description": "recursive_mode:\n * `DISABLED_ERROR` - Recursive change-notify requests return errors immediately.,\n * `DISABLED_IGNORE` - The system accepts recursive change-notify requests but sends notifications only for the top directory that it watches. In other words, the system behaves as if the user doesn't specify the recursive flag. You can use this setting to improve compatibility with applications that request recursive behavior but don't actually depend on it. Important: For scenarios that require recursive behavior, this setting can cause an application to become unresponsive or exhibit other unexpected behavior.,\n * `ENABLED` - The ENABLED option is the default mode, unless you set a different one. This option provides full support for recursive change-notify requests. The system pushes notifications for all descendants of the watched directory to the watcher. Important: This configuration can affect system performance significantly. For example, watching the root of the file system creates a notification for every change on the entire cluster."
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "fs_notify_config",
  "type": "object",
  "properties": {
    "recursive_mode": {
      "type": "string",
      "enum": [
        "DISABLED_ERROR",
        "DISABLED_IGNORE",
        "ENABLED"
      ],
      "description": "recursive_mode:\n * `DISABLED_ERROR` - Recursive change-notify requests return errors immediately.,\n * `DISABLED_IGNORE` - The system accepts recursive change-notify requests but sends notifications only for the top directory that it watches. In other words, the system behaves as if the user doesn't specify the recursive flag. You can use this setting to improve compatibility with applications that request recursive behavior but don't actually depend on it. Important: For scenarios that require recursive behavior, this setting can cause an application to become unresponsive or exhibit other unexpected behavior.,\n * `ENABLED` - The ENABLED option is the default mode, unless you set a different one. This option provides full support for recursive change-notify requests. The system pushes notifications for all descendants of the watched directory to the watcher. Important: This configuration can affect system performance significantly. For example, watching the root of the file system creates a notification for every change on the entire cluster."
    }
  }
}