grafana-foundation-sdk 1759918042!11.4.0__tar.gz → 1759918150!11.2.0__tar.gz

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: grafana_foundation_sdk
-Version: 1759918042!11.4.0
+Version: 1759918150!11.2.0
 Summary: A set of tools, types and libraries for building and manipulating Grafana objects.
 Project-URL: Homepage, https://github.com/grafana/grafana-foundation-sdk
 Project-URL: Repository, https://github.com/grafana/grafana-foundation-sdk.git
@@ -25,13 +25,13 @@ Description-Content-Type: text/markdown
 A set of tools, types and *builder libraries* for building and manipulating Grafana objects in Python.
 
 > [!NOTE]
-> This branch contains **types and builders generated for Grafana v11.4.x.**
+> This branch contains **types and builders generated for Grafana v11.2.x.**
 > Other supported versions of Grafana can be found at [this repository's root](https://github.com/grafana/grafana-foundation-sdk/).
 
 ## Installing
 
 ```shell
-python3 -m pip install 'grafana_foundation_sdk==1759918042!11.4.0'
+python3 -m pip install 'grafana_foundation_sdk==1759918150!11.2.0'
 ```
 
 ## Example usage

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/README.md

@@ -3,13 +3,13 @@
 A set of tools, types and *builder libraries* for building and manipulating Grafana objects in Python.
 
 > [!NOTE]
-> This branch contains **types and builders generated for Grafana v11.4.x.**
+> This branch contains **types and builders generated for Grafana v11.2.x.**
 > Other supported versions of Grafana can be found at [this repository's root](https://github.com/grafana/grafana-foundation-sdk/).
 
 ## Installing
 
 ```shell
-python3 -m pip install 'grafana_foundation_sdk==1759918042!11.4.0'
+python3 -m pip install 'grafana_foundation_sdk==1759918150!11.2.0'
 ```
 
 ## Example usage

grafana_foundation_sdk-1759918150!11.2.0/docs/Installing.md

@@ -0,0 +1,5 @@
+# Installing
+
+```shell
+python3 -m pip install 'grafana_foundation_sdk==1759918150!11.2.0'
+```

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/docs/Reference/alerting/builder-NotificationPolicy.md

@@ -18,12 +18,6 @@ Builds the object.
 def build() -> alerting.NotificationPolicy
 ```
 
-### <span class="badge object-method"></span> active_time_intervals
-
-```python
-def active_time_intervals(active_time_intervals: list[str]) -> typing.Self
-```
-
 ### <span class="badge object-method"></span> continue_val
 
 ```python

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/docs/Reference/alerting/object-NotificationPolicy.md

@@ -16,7 +16,6 @@ class NotificationPolicy:
     from the upstream alertmanager in that it adds the ObjectMatchers property.
     """
 
-    active_time_intervals: typing.Optional[list[str]]
     continue_val: typing.Optional[bool]
     group_by: typing.Optional[list[str]]
     group_interval: typing.Optional[str]

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/docs/Reference/bargauge/builder-Panel.md

@@ -132,12 +132,6 @@ See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transfo
 def interval(interval: str) -> typing.Self
 ```
 
-### <span class="badge object-method"></span> legend
-
-```python
-def legend(legend: cogbuilder.Builder[common.VizLegendOptions]) -> typing.Self
-```
-
 ### <span class="badge object-method"></span> library_panel
 
 Dynamically load the panel

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/docs/Reference/bargauge/object-Options.md

@@ -14,7 +14,6 @@ class Options:
     sizing: common.BarGaugeSizing
     min_viz_width: int
     min_viz_height: int
-    legend: common.VizLegendOptions
     reduce_options: common.ReduceDataOptions
     text: typing.Optional[common.VizTextDisplayOptions]
     max_viz_height: int

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/docs/Reference/cloudwatch/builder-CloudWatchLogsQuery.md

@@ -70,14 +70,6 @@ Log groups to query
 def log_groups(log_groups: list[cogbuilder.Builder[cloudwatch.LogGroup]]) -> typing.Self
 ```
 
-### <span class="badge object-method"></span> query_language
-
-Language used for querying logs, can be CWLI, SQL, or PPL. If empty, the default language is CWLI.
-
-```python
-def query_language(query_language: cloudwatch.LogsQueryLanguage) -> typing.Self
-```
-
 ### <span class="badge object-method"></span> query_mode
 
 Whether a query is a Metrics, Logs, or Annotations query

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/docs/Reference/cloudwatch/index.md

@@ -9,7 +9,6 @@
  * <span class="badge object-type-enum"></span> [CloudWatchQueryMode](./object-CloudWatchQueryMode.md)
  * <span class="badge object-type-map"></span> [Dimensions](./object-Dimensions.md)
  * <span class="badge object-type-class"></span> [LogGroup](./object-LogGroup.md)
- * <span class="badge object-type-enum"></span> [LogsQueryLanguage](./object-LogsQueryLanguage.md)
  * <span class="badge object-type-enum"></span> [MetricEditorMode](./object-MetricEditorMode.md)
  * <span class="badge object-type-enum"></span> [MetricQueryType](./object-MetricQueryType.md)
  * <span class="badge object-type-class"></span> [MetricStat](./object-MetricStat.md)

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/docs/Reference/cloudwatch/object-CloudWatchLogsQuery.md

@@ -24,8 +24,6 @@ class CloudWatchLogsQuery(cogvariants.Dataquery):
     stats_groups: typing.Optional[list[str]]
     # Log groups to query
     log_groups: typing.Optional[list[cloudwatch.LogGroup]]
-    # @deprecated use logGroups
-    log_group_names: typing.Optional[list[str]]
     # A unique identifier for the query within the list of targets.
     # In server side expressions, the refId is used as a variable name to identify results.
     # By default, the UI will assign A->Z; however setting meaningful names may be useful.
@@ -35,8 +33,8 @@ class CloudWatchLogsQuery(cogvariants.Dataquery):
     # Specify the query flavor
     # TODO make this required and give it a default
     query_type: typing.Optional[str]
-    # Language used for querying logs, can be CWLI, SQL, or PPL. If empty, the default language is CWLI.
-    query_language: typing.Optional[cloudwatch.LogsQueryLanguage]
+    # @deprecated use logGroups
+    log_group_names: typing.Optional[list[str]]
     # For mixed data sources the selected datasource is on the query level.
     # For non mixed scenarios this is undefined.
     # TODO find a better way to do this ^ that's friendly to schema

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/docs/Reference/common/object-BarGaugeNamePlacement.md

@@ -16,5 +16,4 @@ class BarGaugeNamePlacement(enum.StrEnum):
     AUTO = "auto"
     TOP = "top"
     LEFT = "left"
-    HIDDEN = "hidden"
 ```

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/docs/Reference/dashboard/object-VariableType.md

@@ -46,5 +46,4 @@ class VariableType(enum.StrEnum):
     TEXTBOX = "textbox"
     CUSTOM = "custom"
     SYSTEM = "system"
-    SNAPSHOT = "snapshot"
 ```

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/grafana_foundation_sdk/builders/alerting.py

@@ -538,11 +538,6 @@ class NotificationPolicy(cogbuilder.Builder[alerting.NotificationPolicy]):
         """
         return self._internal    
     
-    def active_time_intervals(self, active_time_intervals: list[str]) -> typing.Self:    
-        self._internal.active_time_intervals = active_time_intervals
-    
-        return self
-    
     def continue_val(self, continue_val: bool) -> typing.Self:    
         self._internal.continue_val = continue_val
     

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/grafana_foundation_sdk/builders/bargauge.py

@@ -613,15 +613,6 @@ class Panel(cogbuilder.Builder[dashboard.Panel]):
     
         return self
     
-    def legend(self, legend: cogbuilder.Builder[common.VizLegendOptions]) -> typing.Self:    
-        if self._internal.options is None:
-            self._internal.options = bargauge.Options()
-        assert isinstance(self._internal.options, bargauge.Options)
-        legend_resource = legend.build()
-        self._internal.options.legend = legend_resource
-    
-        return self
-    
     def reduce_options(self, reduce_options: cogbuilder.Builder[common.ReduceDataOptions]) -> typing.Self:    
         if self._internal.options is None:
             self._internal.options = bargauge.Options()

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/grafana_foundation_sdk/builders/cloudwatch.py

@@ -660,15 +660,6 @@ class CloudWatchLogsQuery(cogbuilder.Builder[cloudwatch.CloudWatchLogsQuery]):
     
         return self
     
-    def log_group_names(self, log_group_names: list[str]) -> typing.Self:    
-        """
-        @deprecated use logGroups
-        """
-            
-        self._internal.log_group_names = log_group_names
-    
-        return self
-    
     def ref_id(self, ref_id: str) -> typing.Self:    
         """
         A unique identifier for the query within the list of targets.
@@ -699,12 +690,12 @@ class CloudWatchLogsQuery(cogbuilder.Builder[cloudwatch.CloudWatchLogsQuery]):
     
         return self
     
-    def query_language(self, query_language: cloudwatch.LogsQueryLanguage) -> typing.Self:    
+    def log_group_names(self, log_group_names: list[str]) -> typing.Self:    
         """
-        Language used for querying logs, can be CWLI, SQL, or PPL. If empty, the default language is CWLI.
+        @deprecated use logGroups
         """
             
-        self._internal.query_language = query_language
+        self._internal.log_group_names = log_group_names
     
         return self
     

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/grafana_foundation_sdk/models/alerting.py

@@ -564,7 +564,6 @@ class NotificationPolicy:
     from the upstream alertmanager in that it adds the ObjectMatchers property.
     """
 
-    active_time_intervals: typing.Optional[list[str]]
     continue_val: typing.Optional[bool]
     group_by: typing.Optional[list[str]]
     group_interval: typing.Optional[str]
@@ -583,8 +582,7 @@ class NotificationPolicy:
     repeat_interval: typing.Optional[str]
     routes: typing.Optional[list['NotificationPolicy']]
 
-    def __init__(self, active_time_intervals: typing.Optional[list[str]] = None, continue_val: typing.Optional[bool] = None, group_by: typing.Optional[list[str]] = None, group_interval: typing.Optional[str] = None, group_wait: typing.Optional[str] = None, match: typing.Optional[dict[str, str]] = None, match_re: typing.Optional['MatchRegexps'] = None, matchers: typing.Optional['Matchers'] = None, mute_time_intervals: typing.Optional[list[str]] = None, object_matchers: typing.Optional['ObjectMatchers'] = None, provenance: typing.Optional['Provenance'] = None, receiver: typing.Optional[str] = None, repeat_interval: typing.Optional[str] = None, routes: typing.Optional[list['NotificationPolicy']] = None):
-        self.active_time_intervals = active_time_intervals
+    def __init__(self, continue_val: typing.Optional[bool] = None, group_by: typing.Optional[list[str]] = None, group_interval: typing.Optional[str] = None, group_wait: typing.Optional[str] = None, match: typing.Optional[dict[str, str]] = None, match_re: typing.Optional['MatchRegexps'] = None, matchers: typing.Optional['Matchers'] = None, mute_time_intervals: typing.Optional[list[str]] = None, object_matchers: typing.Optional['ObjectMatchers'] = None, provenance: typing.Optional['Provenance'] = None, receiver: typing.Optional[str] = None, repeat_interval: typing.Optional[str] = None, routes: typing.Optional[list['NotificationPolicy']] = None):
         self.continue_val = continue_val
         self.group_by = group_by
         self.group_interval = group_interval
@@ -602,8 +600,6 @@ class NotificationPolicy:
     def to_json(self) -> dict[str, object]:
         payload: dict[str, object] = {
         }
-        if self.active_time_intervals is not None:
-            payload["active_time_intervals"] = self.active_time_intervals
         if self.continue_val is not None:
             payload["continue"] = self.continue_val
         if self.group_by is not None:
@@ -636,8 +632,6 @@ class NotificationPolicy:
     def from_json(cls, data: dict[str, typing.Any]) -> typing.Self:
         args: dict[str, typing.Any] = {}
         
-        if "active_time_intervals" in data:
-            args["active_time_intervals"] = data["active_time_intervals"]
         if "continue" in data:
             args["continue_val"] = data["continue"]
         if "group_by" in data:

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/grafana_foundation_sdk/models/bargauge.py

@@ -13,13 +13,12 @@ class Options:
     sizing: common.BarGaugeSizing
     min_viz_width: int
     min_viz_height: int
-    legend: common.VizLegendOptions
     reduce_options: common.ReduceDataOptions
     text: typing.Optional[common.VizTextDisplayOptions]
     max_viz_height: int
     orientation: common.VizOrientation
 
-    def __init__(self, display_mode: typing.Optional[common.BarGaugeDisplayMode] = None, value_mode: typing.Optional[common.BarGaugeValueMode] = None, name_placement: typing.Optional[common.BarGaugeNamePlacement] = None, show_unfilled: bool = True, sizing: typing.Optional[common.BarGaugeSizing] = None, min_viz_width: int = 8, min_viz_height: int = 16, legend: typing.Optional[common.VizLegendOptions] = None, reduce_options: typing.Optional[common.ReduceDataOptions] = None, text: typing.Optional[common.VizTextDisplayOptions] = None, max_viz_height: int = 300, orientation: typing.Optional[common.VizOrientation] = None):
+    def __init__(self, display_mode: typing.Optional[common.BarGaugeDisplayMode] = None, value_mode: typing.Optional[common.BarGaugeValueMode] = None, name_placement: typing.Optional[common.BarGaugeNamePlacement] = None, show_unfilled: bool = True, sizing: typing.Optional[common.BarGaugeSizing] = None, min_viz_width: int = 8, min_viz_height: int = 16, reduce_options: typing.Optional[common.ReduceDataOptions] = None, text: typing.Optional[common.VizTextDisplayOptions] = None, max_viz_height: int = 300, orientation: typing.Optional[common.VizOrientation] = None):
         self.display_mode = display_mode if display_mode is not None else common.BarGaugeDisplayMode.GRADIENT
         self.value_mode = value_mode if value_mode is not None else common.BarGaugeValueMode.COLOR
         self.name_placement = name_placement if name_placement is not None else common.BarGaugeNamePlacement.AUTO
@@ -27,7 +26,6 @@ class Options:
         self.sizing = sizing if sizing is not None else common.BarGaugeSizing.AUTO
         self.min_viz_width = min_viz_width
         self.min_viz_height = min_viz_height
-        self.legend = legend if legend is not None else common.VizLegendOptions()
         self.reduce_options = reduce_options if reduce_options is not None else common.ReduceDataOptions()
         self.text = text
         self.max_viz_height = max_viz_height
@@ -42,7 +40,6 @@ class Options:
             "sizing": self.sizing,
             "minVizWidth": self.min_viz_width,
             "minVizHeight": self.min_viz_height,
-            "legend": self.legend,
             "reduceOptions": self.reduce_options,
             "maxVizHeight": self.max_viz_height,
             "orientation": self.orientation,
@@ -69,8 +66,6 @@ class Options:
             args["min_viz_width"] = data["minVizWidth"]
         if "minVizHeight" in data:
             args["min_viz_height"] = data["minVizHeight"]
-        if "legend" in data:
-            args["legend"] = common.VizLegendOptions.from_json(data["legend"])
         if "reduceOptions" in data:
             args["reduce_options"] = common.ReduceDataOptions.from_json(data["reduceOptions"])
         if "text" in data:

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/grafana_foundation_sdk/models/cloudwatch.py

@@ -598,12 +598,6 @@ QueryEditorOperatorType: typing.TypeAlias = typing.Union[str, bool, int]
 QueryEditorOperatorValueType: typing.TypeAlias = typing.Union[str, bool, int, list['QueryEditorOperatorType']]
 
 
-class LogsQueryLanguage(enum.StrEnum):
-    CWLI = "CWLI"
-    SQL = "SQL"
-    PPL = "PPL"
-
-
 class CloudWatchLogsQuery(cogvariants.Dataquery):
     """
     Shape of a CloudWatch Logs query
@@ -620,8 +614,6 @@ class CloudWatchLogsQuery(cogvariants.Dataquery):
     stats_groups: typing.Optional[list[str]]
     # Log groups to query
     log_groups: typing.Optional[list['LogGroup']]
-    # @deprecated use logGroups
-    log_group_names: typing.Optional[list[str]]
     # A unique identifier for the query within the list of targets.
     # In server side expressions, the refId is used as a variable name to identify results.
     # By default, the UI will assign A->Z; however setting meaningful names may be useful.
@@ -631,26 +623,25 @@ class CloudWatchLogsQuery(cogvariants.Dataquery):
     # Specify the query flavor
     # TODO make this required and give it a default
     query_type: typing.Optional[str]
-    # Language used for querying logs, can be CWLI, SQL, or PPL. If empty, the default language is CWLI.
-    query_language: typing.Optional['LogsQueryLanguage']
+    # @deprecated use logGroups
+    log_group_names: typing.Optional[list[str]]
     # For mixed data sources the selected datasource is on the query level.
     # For non mixed scenarios this is undefined.
     # TODO find a better way to do this ^ that's friendly to schema
     # TODO this shouldn't be unknown but DataSourceRef | null
     datasource: typing.Optional[dashboard.DataSourceRef]
 
-    def __init__(self, query_mode: typing.Optional['CloudWatchQueryMode'] = None, id_val: str = "", region: str = "", expression: typing.Optional[str] = None, stats_groups: typing.Optional[list[str]] = None, log_groups: typing.Optional[list['LogGroup']] = None, log_group_names: typing.Optional[list[str]] = None, ref_id: str = "", hide: typing.Optional[bool] = None, query_type: typing.Optional[str] = None, query_language: typing.Optional['LogsQueryLanguage'] = None, datasource: typing.Optional[dashboard.DataSourceRef] = None):
+    def __init__(self, query_mode: typing.Optional['CloudWatchQueryMode'] = None, id_val: str = "", region: str = "", expression: typing.Optional[str] = None, stats_groups: typing.Optional[list[str]] = None, log_groups: typing.Optional[list['LogGroup']] = None, ref_id: str = "", hide: typing.Optional[bool] = None, query_type: typing.Optional[str] = None, log_group_names: typing.Optional[list[str]] = None, datasource: typing.Optional[dashboard.DataSourceRef] = None):
         self.query_mode = query_mode if query_mode is not None else CloudWatchQueryMode.LOGS
         self.id_val = id_val
         self.region = region
         self.expression = expression
         self.stats_groups = stats_groups
         self.log_groups = log_groups
-        self.log_group_names = log_group_names
         self.ref_id = ref_id
         self.hide = hide
         self.query_type = query_type
-        self.query_language = query_language
+        self.log_group_names = log_group_names
         self.datasource = datasource
 
     def to_json(self) -> dict[str, object]:
@@ -666,14 +657,12 @@ class CloudWatchLogsQuery(cogvariants.Dataquery):
             payload["statsGroups"] = self.stats_groups
         if self.log_groups is not None:
             payload["logGroups"] = self.log_groups
-        if self.log_group_names is not None:
-            payload["logGroupNames"] = self.log_group_names
         if self.hide is not None:
             payload["hide"] = self.hide
         if self.query_type is not None:
             payload["queryType"] = self.query_type
-        if self.query_language is not None:
-            payload["queryLanguage"] = self.query_language
+        if self.log_group_names is not None:
+            payload["logGroupNames"] = self.log_group_names
         if self.datasource is not None:
             payload["datasource"] = self.datasource
         return payload
@@ -694,16 +683,14 @@ class CloudWatchLogsQuery(cogvariants.Dataquery):
             args["stats_groups"] = data["statsGroups"]
         if "logGroups" in data:
             args["log_groups"] = [LogGroup.from_json(item) for item in data["logGroups"]]
-        if "logGroupNames" in data:
-            args["log_group_names"] = data["logGroupNames"]
         if "refId" in data:
             args["ref_id"] = data["refId"]
         if "hide" in data:
             args["hide"] = data["hide"]
         if "queryType" in data:
             args["query_type"] = data["queryType"]
-        if "queryLanguage" in data:
-            args["query_language"] = data["queryLanguage"]
+        if "logGroupNames" in data:
+            args["log_group_names"] = data["logGroupNames"]
         if "datasource" in data:
             args["datasource"] = dashboard.DataSourceRef.from_json(data["datasource"])        
 

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/grafana_foundation_sdk/models/common.py

@@ -1851,7 +1851,6 @@ class BarGaugeNamePlacement(enum.StrEnum):
     AUTO = "auto"
     TOP = "top"
     LEFT = "left"
-    HIDDEN = "hidden"
 
 
 class BarGaugeSizing(enum.StrEnum):

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/grafana_foundation_sdk/models/dashboard.py

@@ -1620,7 +1620,6 @@ class VariableType(enum.StrEnum):
     TEXTBOX = "textbox"
     CUSTOM = "custom"
     SYSTEM = "system"
-    SNAPSHOT = "snapshot"
 
 
 class VariableHide(enum.IntEnum):

{grafana_foundation_sdk-1759918042!11.4.0 → grafana_foundation_sdk-1759918150!11.2.0}/pyproject.toml

@@ -13,7 +13,7 @@ keywords = [
     "traces",
     "metrics"
 ]
-version = "1759918042!11.4.0"
+version = "1759918150!11.2.0"
 dependencies = []
 requires-python = ">=3.11"
 classifiers = [

grafana_foundation_sdk-1759918042!11.4.0/docs/Installing.md

@@ -1,5 +0,0 @@
-# Installing
-
-```shell
-python3 -m pip install 'grafana_foundation_sdk==1759918042!11.4.0'
-```

grafana_foundation_sdk-1759918042!11.4.0/docs/Reference/cloudwatch/object-LogsQueryLanguage.md

@@ -1,13 +0,0 @@
----
-title: <span class="badge object-type-enum"></span> LogsQueryLanguage
----
-# <span class="badge object-type-enum"></span> LogsQueryLanguage
-
-## Definition
-
-```python
-class LogsQueryLanguage(enum.StrEnum):
-    CWLI = "CWLI"
-    SQL = "SQL"
-    PPL = "PPL"
-```