catocli 3.0.10__py3-none-any.whl → 3.0.12__py3-none-any.whl

models/query.accountMetrics.json

@@ -98,6 +98,24 @@
             },
             "varName": "accountID"
         },
+        "buckets": {
+            "defaultValue": null,
+            "description": "number of buckets, defaults to 10, max 1000",
+            "id_str": "timeseries___buckets",
+            "name": "buckets",
+            "path": "timeseries.buckets",
+            "requestStr": "$buckets:Int ",
+            "required": false,
+            "responseStr": "buckets:$buckets ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Int",
+                "non_null": false
+            },
+            "varName": "buckets"
+        },
         "groupDevices": {
             "defaultValue": null,
             "description": "When the boolean argument groupDevices is set to __true__, then the analytics for all the\nSockets (usually two in high availability) are aggregated as one result.\n\nFor the best results for aggregated Sockets, we recommend that there is consistent\nnames and functionality (for example Destination) for the links on both Sockets.",
@@ -134,6 +152,208 @@
             },
             "varName": "groupInterfaces"
         },
+        "labels": {
+            "defaultValue": null,
+            "description": null,
+            "id_str": "timeseries___labels",
+            "name": "labels",
+            "path": "timeseries.labels",
+            "requestStr": "$labels:[TimeseriesMetricType!] ",
+            "required": false,
+            "responseStr": "labels:$labels ",
+            "type": {
+                "definition": {
+                    "description": null,
+                    "enumValues": [
+                        {
+                            "deprecationReason": null,
+                            "description": "Total avg upstream traffic (from the site to the Cato Cloud)",
+                            "isDeprecated": false,
+                            "name": "bytesUpstream"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Total avg downstream traffic (from the Cato Cloud to the site)",
+                            "isDeprecated": false,
+                            "name": "bytesDownstream"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Total max upstream traffic (from the site to the Cato Cloud)",
+                            "isDeprecated": false,
+                            "name": "bytesUpstreamMax"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Total max downstream traffic (from the site to the Cato Cloud)",
+                            "isDeprecated": false,
+                            "name": "bytesDownstreamMax"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Total upstream packets",
+                            "isDeprecated": false,
+                            "name": "packetsUpstream"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Total downstream packets",
+                            "isDeprecated": false,
+                            "name": "packetsDownstream"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Number of packets lost for upstream traffic",
+                            "isDeprecated": false,
+                            "name": "lostUpstream"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Number of packets lost for downstream traffic",
+                            "isDeprecated": false,
+                            "name": "lostDownstream"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Percent of packet loss for upstream traffic",
+                            "isDeprecated": false,
+                            "name": "lostUpstreamPcnt"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Percent of packet loss for downstream traffic",
+                            "isDeprecated": false,
+                            "name": "lostDownstreamPcnt"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Total packets discarded for downstream traffic",
+                            "isDeprecated": false,
+                            "name": "packetsDiscardedDownstream"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Total packets discarded for upstream traffic",
+                            "isDeprecated": false,
+                            "name": "packetsDiscardedUpstream"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Percent packets discarded for upstream traffic",
+                            "isDeprecated": false,
+                            "name": "packetsDiscardedUpstreamPcnt"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Percent packets discarded for downstream traffic",
+                            "isDeprecated": false,
+                            "name": "packetsDiscardedDownstreamPcnt"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Jitter for upstream traffic (difference in time delay in milliseconds (ms) between data packets)",
+                            "isDeprecated": false,
+                            "name": "jitterUpstream"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Jitter for downstream traffic (difference in time delay in milliseconds (ms) between data packets)",
+                            "isDeprecated": false,
+                            "name": "jitterDownstream"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Total number of bytes of upstream and downstream traffic",
+                            "isDeprecated": false,
+                            "name": "bytesTotal"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Round-trip time from the Socket to the Cato Cloud",
+                            "isDeprecated": false,
+                            "name": "rtt"
+                        },
+                        {
+                            "deprecationReason": "No longer supported",
+                            "description": "Health analytics for the site",
+                            "isDeprecated": true,
+                            "name": "health"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "The age of the physical tunnel in milliseconds (It is zeroed even on transparent reconnect)",
+                            "isDeprecated": false,
+                            "name": "tunnelAge"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Packet loss from socket directly to a well known global services, not through Cato This is used to measure last\nmile provider's performance, independent of the service.",
+                            "isDeprecated": false,
+                            "name": "lastMilePacketLoss"
+                        },
+                        {
+                            "deprecationReason": null,
+                            "description": "Latency from socket directly to a well known global service, not through Cato. This is used to measure last\nmile provider's performance, independent of the service.",
+                            "isDeprecated": false,
+                            "name": "lastMileLatency"
+                        }
+                    ],
+                    "fields": null,
+                    "inputFields": null,
+                    "interfaces": null,
+                    "kind": "ENUM",
+                    "name": "TimeseriesMetricType",
+                    "possibleTypes": null
+                },
+                "indexType": "enum",
+                "kind": [
+                    "LIST",
+                    "NON_NULL",
+                    "ENUM"
+                ],
+                "name": "TimeseriesMetricType",
+                "non_null": false
+            },
+            "varName": "labels"
+        },
+        "perSecond": {
+            "defaultValue": "true",
+            "description": "whether to normalize the data into per second (i.e. divide by granularity)",
+            "id_str": "data___perSecond",
+            "name": "perSecond",
+            "path": "data.perSecond",
+            "requestStr": "$perSecond:Boolean ",
+            "required": false,
+            "responseStr": "perSecond:$perSecond ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Boolean",
+                "non_null": false
+            },
+            "varName": "perSecond"
+        },
+        "siteIDs": {
+            "defaultValue": null,
+            "description": "A list of unique IDs for each site. If specified, only sites in this list are returned. Otherwise, all sites are returned.",
+            "id_str": "sites___siteIDs",
+            "name": "siteIDs",
+            "path": "sites.siteIDs",
+            "requestStr": "$siteIDs:[ID!] ",
+            "required": false,
+            "responseStr": "siteIDs:$siteIDs ",
+            "type": {
+                "kind": [
+                    "LIST",
+                    "NON_NULL",
+                    "SCALAR"
+                ],
+                "name": "ID",
+                "non_null": false
+            },
+            "varName": "siteIDs"
+        },
         "timeFrame": {
             "defaultValue": null,
             "description": "The time frame for the data that the query returns. The argument is in the format type.time value. This argument is mandatory.",
@@ -152,6 +372,100 @@
                 "non_null": false
             },
             "varName": "timeFrame"
+        },
+        "toRate": {
+            "defaultValue": "false",
+            "description": "Normalize collected metrics as per-second values",
+            "id_str": "metrics___toRate",
+            "name": "toRate",
+            "path": "metrics.toRate",
+            "requestStr": "$toRate:Boolean ",
+            "required": false,
+            "responseStr": "toRate:$toRate ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Boolean",
+                "non_null": false
+            },
+            "varName": "toRate"
+        },
+        "types": {
+            "defaultValue": null,
+            "description": null,
+            "id_str": "annotations___types",
+            "name": "types",
+            "path": "annotations.types",
+            "requestStr": "$types:[String!] ",
+            "required": false,
+            "responseStr": "types:$types ",
+            "type": {
+                "kind": [
+                    "LIST",
+                    "NON_NULL",
+                    "SCALAR"
+                ],
+                "name": "String",
+                "non_null": false
+            },
+            "varName": "types"
+        },
+        "useDefaultSizeBucket": {
+            "defaultValue": "false",
+            "description": "In case we want to have the default size bucket (from properties)",
+            "id_str": "data___useDefaultSizeBucket",
+            "name": "useDefaultSizeBucket",
+            "path": "data.useDefaultSizeBucket",
+            "requestStr": "$useDefaultSizeBucket:Boolean ",
+            "required": false,
+            "responseStr": "useDefaultSizeBucket:$useDefaultSizeBucket ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Boolean",
+                "non_null": false
+            },
+            "varName": "useDefaultSizeBucket"
+        },
+        "userIDs": {
+            "defaultValue": null,
+            "description": "A list of unique IDs for each user. If specified, only users in this list are returned. Otherwise, no user metrics are returned.",
+            "id_str": "users___userIDs",
+            "name": "userIDs",
+            "path": "users.userIDs",
+            "requestStr": "$userIDs:[ID!] ",
+            "required": false,
+            "responseStr": "userIDs:$userIDs ",
+            "type": {
+                "kind": [
+                    "LIST",
+                    "NON_NULL",
+                    "SCALAR"
+                ],
+                "name": "ID",
+                "non_null": false
+            },
+            "varName": "userIDs"
+        },
+        "withMissingData": {
+            "defaultValue": "false",
+            "description": "If false, the data field will be set to '0' for buckets with no reported data. Otherwise it will be set to -1",
+            "id_str": "data___withMissingData",
+            "name": "withMissingData",
+            "path": "data.withMissingData",
+            "requestStr": "$withMissingData:Boolean ",
+            "required": false,
+            "responseStr": "withMissingData:$withMissingData ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Boolean",
+                "non_null": false
+            },
+            "varName": "withMissingData"
         }
     },
     "path": "query.accountMetrics",
@@ -11786,8 +12100,26 @@
         "non_null": false
     },
     "variablesPayload": {
+        "buckets": 1,
         "groupDevices": true,
         "groupInterfaces": true,
-        "timeFrame": "example_value"
+        "labels": "bytesUpstream",
+        "perSecond": true,
+        "siteIDs": [
+            "id1",
+            "id2"
+        ],
+        "timeFrame": "example_value",
+        "toRate": true,
+        "types": [
+            "string1",
+            "string2"
+        ],
+        "useDefaultSizeBucket": true,
+        "userIDs": [
+            "id1",
+            "id2"
+        ],
+        "withMissingData": true
     }
 }

models/query.accountSnapshot.json

@@ -42,6 +42,46 @@
                 "non_null": false
             },
             "varName": "accountID"
+        },
+        "siteIDs": {
+            "defaultValue": null,
+            "description": "List of Unique Site Identifiers. If specified, only sites in list will be returned",
+            "id_str": "sites___siteIDs",
+            "name": "siteIDs",
+            "path": "sites.siteIDs",
+            "requestStr": "$siteIDs:[ID!] ",
+            "required": false,
+            "responseStr": "siteIDs:$siteIDs ",
+            "type": {
+                "kind": [
+                    "LIST",
+                    "NON_NULL",
+                    "SCALAR"
+                ],
+                "name": "ID",
+                "non_null": false
+            },
+            "varName": "siteIDs"
+        },
+        "userIDs": {
+            "defaultValue": null,
+            "description": "request specific IDs, regardless of if connected or not",
+            "id_str": "users___userIDs",
+            "name": "userIDs",
+            "path": "users.userIDs",
+            "requestStr": "$userIDs:[ID!] ",
+            "required": false,
+            "responseStr": "userIDs:$userIDs ",
+            "type": {
+                "kind": [
+                    "LIST",
+                    "NON_NULL",
+                    "SCALAR"
+                ],
+                "name": "ID",
+                "non_null": false
+            },
+            "varName": "userIDs"
         }
     },
     "path": "query.accountSnapshot",
@@ -7700,5 +7740,14 @@
         "name": "AccountSnapshot",
         "non_null": false
     },
-    "variablesPayload": {}
+    "variablesPayload": {
+        "siteIDs": [
+            "id1",
+            "id2"
+        ],
+        "userIDs": [
+            "id1",
+            "id2"
+        ]
+    }
 }

models/query.appStats.json

@@ -2961,6 +2961,42 @@
             },
             "varName": "dimension"
         },
+        "from": {
+            "defaultValue": null,
+            "description": null,
+            "id_str": "records___from",
+            "name": "from",
+            "path": "records.from",
+            "requestStr": "$from:Int ",
+            "required": false,
+            "responseStr": "from:$from ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Int",
+                "non_null": false
+            },
+            "varName": "from"
+        },
+        "limit": {
+            "defaultValue": null,
+            "description": null,
+            "id_str": "records___limit",
+            "name": "limit",
+            "path": "records.limit",
+            "requestStr": "$limit:Int ",
+            "required": false,
+            "responseStr": "limit:$limit ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Int",
+                "non_null": false
+            },
+            "varName": "limit"
+        },
         "measure": {
             "defaultValue": null,
             "description": null,
@@ -4512,6 +4548,8 @@
         "dimension": {
             "fieldName": "ad_name"
         },
+        "from": 1,
+        "limit": 1,
         "measure": {
             "aggType": "sum",
             "fieldName": "ad_name",

models/query.appStatsTimeSeries.json

@@ -1823,6 +1823,25 @@
             },
             "varName": "appStatsFilter"
         },
+        "buckets": {
+            "defaultValue": null,
+            "description": null,
+            "id_str": "timeseries___buckets",
+            "name": "buckets",
+            "path": "timeseries.buckets",
+            "requestStr": "$buckets:Int! ",
+            "required": true,
+            "responseStr": "buckets:$buckets ",
+            "type": {
+                "kind": [
+                    "NON_NULL",
+                    "SCALAR"
+                ],
+                "name": "Int",
+                "non_null": false
+            },
+            "varName": "buckets"
+        },
         "dimension": {
             "defaultValue": null,
             "description": null,
@@ -2632,6 +2651,24 @@
             },
             "varName": "measure"
         },
+        "perSecond": {
+            "defaultValue": "true",
+            "description": "whether to normalize the data into per second (i.e. divide by granularity)",
+            "id_str": "data___perSecond",
+            "name": "perSecond",
+            "path": "data.perSecond",
+            "requestStr": "$perSecond:Boolean ",
+            "required": false,
+            "responseStr": "perSecond:$perSecond ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Boolean",
+                "non_null": false
+            },
+            "varName": "perSecond"
+        },
         "timeFrame": {
             "defaultValue": null,
             "description": null,
@@ -2650,6 +2687,42 @@
                 "non_null": false
             },
             "varName": "timeFrame"
+        },
+        "useDefaultSizeBucket": {
+            "defaultValue": "false",
+            "description": "In case we want to have the default size bucket (from properties)",
+            "id_str": "data___useDefaultSizeBucket",
+            "name": "useDefaultSizeBucket",
+            "path": "data.useDefaultSizeBucket",
+            "requestStr": "$useDefaultSizeBucket:Boolean ",
+            "required": false,
+            "responseStr": "useDefaultSizeBucket:$useDefaultSizeBucket ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Boolean",
+                "non_null": false
+            },
+            "varName": "useDefaultSizeBucket"
+        },
+        "withMissingData": {
+            "defaultValue": "false",
+            "description": "If false, the data field will be set to '0' for buckets with no reported data. Otherwise it will be set to -1",
+            "id_str": "data___withMissingData",
+            "name": "withMissingData",
+            "path": "data.withMissingData",
+            "requestStr": "$withMissingData:Boolean ",
+            "required": false,
+            "responseStr": "withMissingData:$withMissingData ",
+            "type": {
+                "kind": [
+                    "SCALAR"
+                ],
+                "name": "Boolean",
+                "non_null": false
+            },
+            "varName": "withMissingData"
         }
     },
     "path": "query.appStatsTimeSeries",
@@ -3257,6 +3330,7 @@
                 "string2"
             ]
         },
+        "buckets": 1,
         "dimension": {
             "fieldName": "ad_name"
         },
@@ -3265,6 +3339,9 @@
             "fieldName": "ad_name",
             "trend": true
         },
-        "timeFrame": "example_value"
+        "perSecond": true,
+        "timeFrame": "example_value",
+        "useDefaultSizeBucket": true,
+        "withMissingData": true
     }
 }