Skip to content

backupWindowsForObjects

Returns backup window information for the specified managed objects. The optional scope argument selects which layer to return per object: OBJECT_LEVEL (the override only) or SLA_LEVEL (the SLA's window only). When omitted (UNSPECIFIED), the effective window is returned: the object-level override if set, else the SLA window. Each entry's scope discriminator reports the layer that supplied the returned window, always OBJECT_LEVEL or SLA_LEVEL. Entries are returned positionally -- one per input id, in request order -- unless sortBy asks for a different order.

Arguments

Argument Type Description
objectIds (required) [UUID!]! Identifiers of the managed objects to look up.
scope BackupWindowScope Which backup window layer to return: OBJECT_LEVEL or SLA_LEVEL. Defaults to effective behavior when omitted.
sortBy BackupWindowsForObjectsSortByField Attribute to order the returned entries by. Omit to keep request order. OBJECT_NAME orders by the managed object name, which is resolved server-side and is not part of the reply.
sortOrder SortOrder Direction to apply to sortBy. Defaults to ASC.

Returns

BackupWindowsForObjectsReply!

Sample

query BackupWindowsForObjects($objectIds: [UUID!]!) {
  backupWindowsForObjects(objectIds: $objectIds)
}
{
  "objectIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
{
  "data": {
    "backupWindowsForObjects": {
      "entries": [
        {
          "objectId": "00000000-0000-0000-0000-000000000000",
          "pendingBackupWindowStatus": "NO_PENDING_BACKUP_WINDOW_ASSIGNMENT",
          "scope": "BACKUP_WINDOW_SCOPE_OBJECT_LEVEL"
        }
      ]
    }
  }
}