setupInfo element

Type:

Service configuration information.

This object is used to configure a new service, complete with a set of roles and the respective configurations.

See the parent class ApiService for minimal specification, which is simply the service name and type.

Note that all fields here are optional. The semantics of not providing a value may change depending on the call being made. Refer to the documentation of the appropriate call for the behavior of optional fields.

Example JSON

{
  "config" : {
    "roleTypeConfigs" : [ {
      "roleType" : "...",
      "items" : [ {
        "name" : "...",
        "value" : "...",
        "required" : false,
        "default" : "...",
        "displayName" : "...",
        "description" : "...",
        "relatedName" : "...",
        "validationState" : "OK",
        "validationMessage" : "..."
      }, ... ]
    }, ... ],
    "items" : [ {
      "name" : "...",
      "value" : "...",
      "required" : false,
      "default" : "...",
      "displayName" : "...",
      "description" : "...",
      "relatedName" : "...",
      "validationState" : "OK",
      "validationMessage" : "..."
    }, ... ]
  },
  "roles" : [ {
    "config" : {
      "items" : [ {
        "name" : "...",
        "value" : "...",
        "required" : false,
        "default" : "...",
        "displayName" : "...",
        "description" : "...",
        "relatedName" : "...",
        "validationState" : "OK",
        "validationMessage" : "..."
      }, ... ]
    },
    "name" : "...",
    "type" : "...",
    "hostRef" : {
      "hostId" : "..."
    },
    "serviceRef" : {
      "clusterName" : "...",
      "serviceName" : "..."
    },
    "roleState" : "HISTORY_NOT_AVAILABLE",
    "healthSummary" : "DISABLED",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "DISABLED"
    }, ... ],
    "haStatus" : "ACTIVE",
    "roleUrl" : "..."
  }, ... ],
  "name" : "...",
  "type" : "...",
  "clusterRef" : {
    "clusterName" : "..."
  },
  "serviceState" : "HISTORY_NOT_AVAILABLE",
  "healthSummary" : "DISABLED",
  "configStale" : false,
  "healthChecks" : [ {
    "name" : "...",
    "summary" : "DISABLED"
  }, ... ],
  "serviceUrl" : "..."
}