Resource URL: /platform/<<version=3>>/cloud/settings

    Overview: This resource applies the standard settings pattern to OneFS
              cloud pool settings.

     Methods: GET, PUT

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

Method GET: List all cloud settings.

       URL: GET /platform/<<version=3>>/cloud/settings

There are no query arguments for this method.

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", 
          "properties": {
            "retry_coefficient_recall": {
              "type": "string", 
              "description": "Coefficients in the quadratic function for determining the rest period between successive recall attempts."
            }, 
            "sleep_timeout_cloud_garbage_collection": {
              "type": "object", 
              "description": "Amount of time to wait between successive file cloud garbage collection operations.", 
              "properties": {
                "recovery_with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread with pending tasks"
                }, 
                "recovery_without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread without pending tasks"
                }, 
                "without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread without pending tasks"
                }, 
                "with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread with pending tasks"
                }
              }
            }, 
            "sleep_timeout_recall": {
              "type": "object", 
              "description": "Amount of time to wait between successive file recall operations.", 
              "properties": {
                "recovery_with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread with pending tasks"
                }, 
                "recovery_without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread without pending tasks"
                }, 
                "without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread without pending tasks"
                }, 
                "with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread with pending tasks"
                }
              }
            }, 
            "retry_coefficient_archive": {
              "type": "string", 
              "description": "Coefficients in the quadratic function for determining the rest period between successive archive attempts."
            }, 
            "sleep_timeout_cache_invalidation": {
              "type": "object", 
              "description": "Amount of time to wait between successive file cache_invalidation operations.", 
              "properties": {
                "recovery_with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread with pending tasks"
                }, 
                "recovery_without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread without pending tasks"
                }, 
                "without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread without pending tasks"
                }, 
                "with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread with pending tasks"
                }
              }
            }, 
            "retry_coefficient_read_ahead": {
              "type": "string", 
              "description": "Coefficients in the quadratic function for determining the rest period between successive read ahead attempts."
            }, 
            "retry_coefficient_writeback": {
              "type": "string", 
              "description": "Coefficients in the quadratic function for determining the rest period between successive writeback attempts."
            }, 
            "sleep_timeout_archive": {
              "type": "object", 
              "description": "Amount of time to wait between successive file archive operations.", 
              "properties": {
                "recovery_with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread with pending tasks"
                }, 
                "recovery_without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread without pending tasks"
                }, 
                "without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread without pending tasks"
                }, 
                "with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread with pending tasks"
                }
              }
            }, 
            "sleep_timeout_local_garbage_collection": {
              "type": "object", 
              "description": "Amount of time to wait between successive file local garbage collection operations.", 
              "properties": {
                "recovery_with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread with pending tasks"
                }, 
                "recovery_without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread without pending tasks"
                }, 
                "without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread without pending tasks"
                }, 
                "with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread with pending tasks"
                }
              }
            }, 
            "sleep_timeout_read_ahead": {
              "type": "object", 
              "description": "Amount of time to wait between successive file read ahead operations.", 
              "properties": {
                "recovery_with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread with pending tasks"
                }, 
                "recovery_without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread without pending tasks"
                }, 
                "without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread without pending tasks"
                }, 
                "with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread with pending tasks"
                }
              }
            }, 
            "retry_coefficient_cloud_garbage_collection": {
              "type": "string", 
              "description": "Coefficients in the quadratic function for determining the rest period between successive cloud garbage collection attempts."
            }, 
            "cloud_policy_defaults": {
              "type": "object", 
              "description": "The default filepool policy values for cloudpools.", 
              "properties": {
                "compression": {
                  "type": "boolean", 
                  "description": "Specifies if files should be compressed."
                }, 
                "writeback_frequency": {
                  "type": "integer", 
                  "description": "The minimum amount of time to wait before updating cloud data with local changes."
                }, 
                "encryption": {
                  "type": "boolean", 
                  "description": "Specifies if files should be encrypted."
                }, 
                "incremental_backup_retention": {
                  "type": "integer", 
                  "description": "(Used with SyncIQ and NDMP backups.)  The minimum amount of time cloud files will be retained after the creation of a SyncIQ backup or an incremental NDMP backup."
                }, 
                "cache": {
                  "type": "object", 
                  "description": "Specifies default cloudpool cache settings for new filepool policies.", 
                  "properties": {
                    "type": {
                      "enum": [
                        "cached", 
                        "no-cache"
                      ], 
                      "type": "string", 
                      "description": "Specifies cache type."
                    }, 
                    "read_ahead": {
                      "enum": [
                        "partial", 
                        "full"
                      ], 
                      "type": "string", 
                      "description": "Specifies cache read ahead type."
                    }, 
                    "expiration": {
                      "type": "integer", 
                      "description": "Specifies cache expiration."
                    }
                  }
                }, 
                "data_retention": {
                  "type": "integer", 
                  "description": "Specifies the minimum amount of time archived data will be retained in the cloud after deletion."
                }, 
                "archive_snapshot_files": {
                  "type": "boolean", 
                  "description": "Specifies if files with snapshots should be archived."
                }, 
                "full_backup_retention": {
                  "type": "integer", 
                  "description": "(Used with NDMP backups only.  Not applicable to SyncIQ.)  The minimum amount of time cloud files will be retained after the creation of a full NDMP backup."
                }
              }
            }, 
            "retry_coefficient_local_garbage_collection": {
              "type": "string", 
              "description": "Coefficients in the quadratic function for determining the rest period between successive local garbage collection attempts."
            }, 
            "retry_coefficient_cache_invalidation": {
              "type": "string", 
              "description": "Coefficients in the quadratic function for determining the rest period between successive cache invalidation attempts."
            }, 
            "sleep_timeout_writeback": {
              "type": "object", 
              "description": "Amount of time to wait between successive file writeback operations.", 
              "properties": {
                "recovery_with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread with pending tasks"
                }, 
                "recovery_without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a recovery thread without pending tasks"
                }, 
                "without_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread without pending tasks"
                }, 
                "with_tasks": {
                  "type": "number", 
                  "description": "Sleep timeout for a non-recovery thread with pending tasks"
                }
              }
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Modify one or more settings.

       URL: PUT /platform/<<version=3>>/cloud/settings

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "retry_coefficient_recall": {
      "type": "string", 
      "description": "Coefficients in the quadratic function for determining the rest period between successive recall attempts."
    }, 
    "sleep_timeout_cloud_garbage_collection": {
      "type": "object", 
      "description": "Amount of time to wait between successive file cloud garbage collection operations.", 
      "properties": {
        "recovery_with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread with pending tasks"
        }, 
        "recovery_without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread without pending tasks"
        }, 
        "without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread without pending tasks"
        }, 
        "with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread with pending tasks"
        }
      }
    }, 
    "sleep_timeout_recall": {
      "type": "object", 
      "description": "Amount of time to wait between successive file recall operations.", 
      "properties": {
        "recovery_with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread with pending tasks"
        }, 
        "recovery_without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread without pending tasks"
        }, 
        "without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread without pending tasks"
        }, 
        "with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread with pending tasks"
        }
      }
    }, 
    "retry_coefficient_archive": {
      "type": "string", 
      "description": "Coefficients in the quadratic function for determining the rest period between successive archive attempts."
    }, 
    "sleep_timeout_cache_invalidation": {
      "type": "object", 
      "description": "Amount of time to wait between successive file cache_invalidation operations.", 
      "properties": {
        "recovery_with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread with pending tasks"
        }, 
        "recovery_without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread without pending tasks"
        }, 
        "without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread without pending tasks"
        }, 
        "with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread with pending tasks"
        }
      }
    }, 
    "retry_coefficient_read_ahead": {
      "type": "string", 
      "description": "Coefficients in the quadratic function for determining the rest period between successive read ahead attempts."
    }, 
    "retry_coefficient_writeback": {
      "type": "string", 
      "description": "Coefficients in the quadratic function for determining the rest period between successive writeback attempts."
    }, 
    "sleep_timeout_archive": {
      "type": "object", 
      "description": "Amount of time to wait between successive file archive operations.", 
      "properties": {
        "recovery_with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread with pending tasks"
        }, 
        "recovery_without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread without pending tasks"
        }, 
        "without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread without pending tasks"
        }, 
        "with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread with pending tasks"
        }
      }
    }, 
    "sleep_timeout_local_garbage_collection": {
      "type": "object", 
      "description": "Amount of time to wait between successive file local garbage collection operations.", 
      "properties": {
        "recovery_with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread with pending tasks"
        }, 
        "recovery_without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread without pending tasks"
        }, 
        "without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread without pending tasks"
        }, 
        "with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread with pending tasks"
        }
      }
    }, 
    "sleep_timeout_read_ahead": {
      "type": "object", 
      "description": "Amount of time to wait between successive file read ahead operations.", 
      "properties": {
        "recovery_with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread with pending tasks"
        }, 
        "recovery_without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread without pending tasks"
        }, 
        "without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread without pending tasks"
        }, 
        "with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread with pending tasks"
        }
      }
    }, 
    "retry_coefficient_cloud_garbage_collection": {
      "type": "string", 
      "description": "Coefficients in the quadratic function for determining the rest period between successive cloud garbage collection attempts."
    }, 
    "cloud_policy_defaults": {
      "type": "object", 
      "description": "The default filepool policy values for cloudpools.", 
      "properties": {
        "compression": {
          "type": "boolean", 
          "description": "Specifies if files should be compressed."
        }, 
        "writeback_frequency": {
          "type": "integer", 
          "description": "The minimum amount of time to wait before updating cloud data with local changes."
        }, 
        "encryption": {
          "type": "boolean", 
          "description": "Specifies if files should be encrypted."
        }, 
        "incremental_backup_retention": {
          "type": "integer", 
          "description": "(Used with SyncIQ and NDMP backups.)  The minimum amount of time cloud files will be retained after the creation of a SyncIQ backup or an incremental NDMP backup."
        }, 
        "cache": {
          "type": "object", 
          "description": "Specifies default cloudpool cache settings for new filepool policies.", 
          "properties": {
            "type": {
              "enum": [
                "cached", 
                "no-cache"
              ], 
              "type": "string", 
              "description": "Specifies cache type."
            }, 
            "read_ahead": {
              "enum": [
                "partial", 
                "full"
              ], 
              "type": "string", 
              "description": "Specifies cache read ahead type."
            }, 
            "expiration": {
              "type": "integer", 
              "description": "Specifies cache expiration."
            }
          }
        }, 
        "data_retention": {
          "type": "integer", 
          "description": "Specifies the minimum amount of time archived data will be retained in the cloud after deletion."
        }, 
        "archive_snapshot_files": {
          "type": "boolean", 
          "description": "Specifies if files with snapshots should be archived."
        }, 
        "full_backup_retention": {
          "type": "integer", 
          "description": "(Used with NDMP backups only.  Not applicable to SyncIQ.)  The minimum amount of time cloud files will be retained after the creation of a full NDMP backup."
        }
      }
    }, 
    "retry_coefficient_local_garbage_collection": {
      "type": "string", 
      "description": "Coefficients in the quadratic function for determining the rest period between successive local garbage collection attempts."
    }, 
    "retry_coefficient_cache_invalidation": {
      "type": "string", 
      "description": "Coefficients in the quadratic function for determining the rest period between successive cache invalidation attempts."
    }, 
    "sleep_timeout_writeback": {
      "type": "object", 
      "description": "Amount of time to wait between successive file writeback operations.", 
      "properties": {
        "recovery_with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread with pending tasks"
        }, 
        "recovery_without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a recovery thread without pending tasks"
        }, 
        "without_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread without pending tasks"
        }, 
        "with_tasks": {
          "type": "number", 
          "description": "Sleep timeout for a non-recovery thread with pending tasks"
        }
      }
    }
  }
}

There is no JSON response body for this method.
