nominal-api 0.510.0__py3-none-any.whl → 0.511.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- nominal_api/__init__.py +2 -1
- nominal_api/_impl.py +975 -148
- nominal_api/scout_datareview_api/__init__.py +2 -0
- nominal_api/themes_api/__init__.py +20 -0
- {nominal_api-0.510.0.dist-info → nominal_api-0.511.1.dist-info}/METADATA +1 -1
- {nominal_api-0.510.0.dist-info → nominal_api-0.511.1.dist-info}/RECORD +8 -7
- {nominal_api-0.510.0.dist-info → nominal_api-0.511.1.dist-info}/WHEEL +0 -0
- {nominal_api-0.510.0.dist-info → nominal_api-0.511.1.dist-info}/top_level.txt +0 -0
nominal_api/_impl.py
CHANGED
@@ -43088,6 +43088,26 @@ scout_dataexport_api_UndecimatedResolution.__qualname__ = "UndecimatedResolution
|
|
43088
43088
|
scout_dataexport_api_UndecimatedResolution.__module__ = "nominal_api.scout_dataexport_api"
|
43089
43089
|
|
43090
43090
|
|
43091
|
+
class scout_datareview_api_ArchiveDataReview(ConjureBeanType):
|
43092
|
+
"""
|
43093
|
+
Archive the data review which created this check alert. Only performable via the archive data review endpoint;
|
43094
|
+
not supported by Perform Check Alert Action.
|
43095
|
+
"""
|
43096
|
+
|
43097
|
+
@builtins.classmethod
|
43098
|
+
def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
|
43099
|
+
return {
|
43100
|
+
}
|
43101
|
+
|
43102
|
+
__slots__: List[str] = []
|
43103
|
+
|
43104
|
+
|
43105
|
+
|
43106
|
+
scout_datareview_api_ArchiveDataReview.__name__ = "ArchiveDataReview"
|
43107
|
+
scout_datareview_api_ArchiveDataReview.__qualname__ = "ArchiveDataReview"
|
43108
|
+
scout_datareview_api_ArchiveDataReview.__module__ = "nominal_api.scout_datareview_api"
|
43109
|
+
|
43110
|
+
|
43091
43111
|
class scout_datareview_api_AutomaticCheckEvaluation(ConjureBeanType):
|
43092
43112
|
|
43093
43113
|
@builtins.classmethod
|
@@ -44056,6 +44076,8 @@ class scout_datareview_api_CheckAlertAction(ConjureUnionType):
|
|
44056
44076
|
_update_notes: Optional["scout_datareview_api_UpdateNotes"] = None
|
44057
44077
|
_link_notebook: Optional["scout_datareview_api_LinkNotebook"] = None
|
44058
44078
|
_unlink_notebook: Optional["scout_datareview_api_UnlinkNotebook"] = None
|
44079
|
+
_archive_data_review: Optional["scout_datareview_api_ArchiveDataReview"] = None
|
44080
|
+
_unarchive_data_review: Optional["scout_datareview_api_UnarchiveDataReview"] = None
|
44059
44081
|
|
44060
44082
|
@builtins.classmethod
|
44061
44083
|
def _options(cls) -> Dict[str, ConjureFieldDefinition]:
|
@@ -44066,7 +44088,9 @@ class scout_datareview_api_CheckAlertAction(ConjureUnionType):
|
|
44066
44088
|
'reassign': ConjureFieldDefinition('reassign', scout_datareview_api_Reassign),
|
44067
44089
|
'update_notes': ConjureFieldDefinition('updateNotes', scout_datareview_api_UpdateNotes),
|
44068
44090
|
'link_notebook': ConjureFieldDefinition('linkNotebook', scout_datareview_api_LinkNotebook),
|
44069
|
-
'unlink_notebook': ConjureFieldDefinition('unlinkNotebook', scout_datareview_api_UnlinkNotebook)
|
44091
|
+
'unlink_notebook': ConjureFieldDefinition('unlinkNotebook', scout_datareview_api_UnlinkNotebook),
|
44092
|
+
'archive_data_review': ConjureFieldDefinition('archiveDataReview', scout_datareview_api_ArchiveDataReview),
|
44093
|
+
'unarchive_data_review': ConjureFieldDefinition('unarchiveDataReview', scout_datareview_api_UnarchiveDataReview)
|
44070
44094
|
}
|
44071
44095
|
|
44072
44096
|
def __init__(
|
@@ -44078,10 +44102,12 @@ class scout_datareview_api_CheckAlertAction(ConjureUnionType):
|
|
44078
44102
|
update_notes: Optional["scout_datareview_api_UpdateNotes"] = None,
|
44079
44103
|
link_notebook: Optional["scout_datareview_api_LinkNotebook"] = None,
|
44080
44104
|
unlink_notebook: Optional["scout_datareview_api_UnlinkNotebook"] = None,
|
44105
|
+
archive_data_review: Optional["scout_datareview_api_ArchiveDataReview"] = None,
|
44106
|
+
unarchive_data_review: Optional["scout_datareview_api_UnarchiveDataReview"] = None,
|
44081
44107
|
type_of_union: Optional[str] = None
|
44082
44108
|
) -> None:
|
44083
44109
|
if type_of_union is None:
|
44084
|
-
if (close_with_ignore is not None) + (close_with_further_action is not None) + (reopen is not None) + (reassign is not None) + (update_notes is not None) + (link_notebook is not None) + (unlink_notebook is not None) != 1:
|
44110
|
+
if (close_with_ignore is not None) + (close_with_further_action is not None) + (reopen is not None) + (reassign is not None) + (update_notes is not None) + (link_notebook is not None) + (unlink_notebook is not None) + (archive_data_review is not None) + (unarchive_data_review is not None) != 1:
|
44085
44111
|
raise ValueError('a union must contain a single member')
|
44086
44112
|
|
44087
44113
|
if close_with_ignore is not None:
|
@@ -44105,6 +44131,12 @@ class scout_datareview_api_CheckAlertAction(ConjureUnionType):
|
|
44105
44131
|
if unlink_notebook is not None:
|
44106
44132
|
self._unlink_notebook = unlink_notebook
|
44107
44133
|
self._type = 'unlinkNotebook'
|
44134
|
+
if archive_data_review is not None:
|
44135
|
+
self._archive_data_review = archive_data_review
|
44136
|
+
self._type = 'archiveDataReview'
|
44137
|
+
if unarchive_data_review is not None:
|
44138
|
+
self._unarchive_data_review = unarchive_data_review
|
44139
|
+
self._type = 'unarchiveDataReview'
|
44108
44140
|
|
44109
44141
|
elif type_of_union == 'closeWithIgnore':
|
44110
44142
|
if close_with_ignore is None:
|
@@ -44141,6 +44173,16 @@ class scout_datareview_api_CheckAlertAction(ConjureUnionType):
|
|
44141
44173
|
raise ValueError('a union value must not be None')
|
44142
44174
|
self._unlink_notebook = unlink_notebook
|
44143
44175
|
self._type = 'unlinkNotebook'
|
44176
|
+
elif type_of_union == 'archiveDataReview':
|
44177
|
+
if archive_data_review is None:
|
44178
|
+
raise ValueError('a union value must not be None')
|
44179
|
+
self._archive_data_review = archive_data_review
|
44180
|
+
self._type = 'archiveDataReview'
|
44181
|
+
elif type_of_union == 'unarchiveDataReview':
|
44182
|
+
if unarchive_data_review is None:
|
44183
|
+
raise ValueError('a union value must not be None')
|
44184
|
+
self._unarchive_data_review = unarchive_data_review
|
44185
|
+
self._type = 'unarchiveDataReview'
|
44144
44186
|
|
44145
44187
|
@builtins.property
|
44146
44188
|
def close_with_ignore(self) -> Optional["scout_datareview_api_CloseWithIgnoreAlert"]:
|
@@ -44170,6 +44212,14 @@ class scout_datareview_api_CheckAlertAction(ConjureUnionType):
|
|
44170
44212
|
def unlink_notebook(self) -> Optional["scout_datareview_api_UnlinkNotebook"]:
|
44171
44213
|
return self._unlink_notebook
|
44172
44214
|
|
44215
|
+
@builtins.property
|
44216
|
+
def archive_data_review(self) -> Optional["scout_datareview_api_ArchiveDataReview"]:
|
44217
|
+
return self._archive_data_review
|
44218
|
+
|
44219
|
+
@builtins.property
|
44220
|
+
def unarchive_data_review(self) -> Optional["scout_datareview_api_UnarchiveDataReview"]:
|
44221
|
+
return self._unarchive_data_review
|
44222
|
+
|
44173
44223
|
def accept(self, visitor) -> Any:
|
44174
44224
|
if not isinstance(visitor, scout_datareview_api_CheckAlertActionVisitor):
|
44175
44225
|
raise ValueError('{} is not an instance of scout_datareview_api_CheckAlertActionVisitor'.format(visitor.__class__.__name__))
|
@@ -44187,6 +44237,10 @@ class scout_datareview_api_CheckAlertAction(ConjureUnionType):
|
|
44187
44237
|
return visitor._link_notebook(self.link_notebook)
|
44188
44238
|
if self._type == 'unlinkNotebook' and self.unlink_notebook is not None:
|
44189
44239
|
return visitor._unlink_notebook(self.unlink_notebook)
|
44240
|
+
if self._type == 'archiveDataReview' and self.archive_data_review is not None:
|
44241
|
+
return visitor._archive_data_review(self.archive_data_review)
|
44242
|
+
if self._type == 'unarchiveDataReview' and self.unarchive_data_review is not None:
|
44243
|
+
return visitor._unarchive_data_review(self.unarchive_data_review)
|
44190
44244
|
|
44191
44245
|
|
44192
44246
|
scout_datareview_api_CheckAlertAction.__name__ = "CheckAlertAction"
|
@@ -44224,6 +44278,14 @@ class scout_datareview_api_CheckAlertActionVisitor:
|
|
44224
44278
|
def _unlink_notebook(self, unlink_notebook: "scout_datareview_api_UnlinkNotebook") -> Any:
|
44225
44279
|
pass
|
44226
44280
|
|
44281
|
+
@abstractmethod
|
44282
|
+
def _archive_data_review(self, archive_data_review: "scout_datareview_api_ArchiveDataReview") -> Any:
|
44283
|
+
pass
|
44284
|
+
|
44285
|
+
@abstractmethod
|
44286
|
+
def _unarchive_data_review(self, unarchive_data_review: "scout_datareview_api_UnarchiveDataReview") -> Any:
|
44287
|
+
pass
|
44288
|
+
|
44227
44289
|
|
44228
44290
|
scout_datareview_api_CheckAlertActionVisitor.__name__ = "CheckAlertActionVisitor"
|
44229
44291
|
scout_datareview_api_CheckAlertActionVisitor.__qualname__ = "CheckAlertActionVisitor"
|
@@ -47556,6 +47618,26 @@ scout_datareview_api_TooManyAlertsState.__qualname__ = "TooManyAlertsState"
|
|
47556
47618
|
scout_datareview_api_TooManyAlertsState.__module__ = "nominal_api.scout_datareview_api"
|
47557
47619
|
|
47558
47620
|
|
47621
|
+
class scout_datareview_api_UnarchiveDataReview(ConjureBeanType):
|
47622
|
+
"""
|
47623
|
+
Unarchive the data review which created this check alert. Only performable via the unarchive data review
|
47624
|
+
endpoint; not supported by Perform Check Alert Action.
|
47625
|
+
"""
|
47626
|
+
|
47627
|
+
@builtins.classmethod
|
47628
|
+
def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
|
47629
|
+
return {
|
47630
|
+
}
|
47631
|
+
|
47632
|
+
__slots__: List[str] = []
|
47633
|
+
|
47634
|
+
|
47635
|
+
|
47636
|
+
scout_datareview_api_UnarchiveDataReview.__name__ = "UnarchiveDataReview"
|
47637
|
+
scout_datareview_api_UnarchiveDataReview.__qualname__ = "UnarchiveDataReview"
|
47638
|
+
scout_datareview_api_UnarchiveDataReview.__module__ = "nominal_api.scout_datareview_api"
|
47639
|
+
|
47640
|
+
|
47559
47641
|
class scout_datareview_api_UnlinkNotebook(ConjureBeanType):
|
47560
47642
|
|
47561
47643
|
@builtins.classmethod
|
@@ -61823,199 +61905,940 @@ storage_writer_api_WriteTelegrafBatchesRequest.__qualname__ = "WriteTelegrafBatc
|
|
61823
61905
|
storage_writer_api_WriteTelegrafBatchesRequest.__module__ = "nominal_api.storage_writer_api"
|
61824
61906
|
|
61825
61907
|
|
61826
|
-
class
|
61827
|
-
"""
|
61828
|
-
[INTERNAL]
|
61829
|
-
A series archetype represents the constant information about data in a series - specifically, the name, units, a
|
61830
|
-
description, and the tags. Series archetypes can be used to query points from specific series depending on the tag
|
61831
|
-
value selections.
|
61832
|
-
"""
|
61833
|
-
|
61834
|
-
def batch_get(self, auth_header: str, request: "timeseries_archetype_api_BatchGetSeriesArchetypeRequest") -> "timeseries_archetype_api_BatchGetSeriesArchetypeResponse":
|
61835
|
-
"""
|
61836
|
-
Batch get series archetypes by DataSourceRid.
|
61837
|
-
"""
|
61838
|
-
|
61839
|
-
_headers: Dict[str, Any] = {
|
61840
|
-
'Accept': 'application/json',
|
61841
|
-
'Content-Type': 'application/json',
|
61842
|
-
'Authorization': auth_header,
|
61843
|
-
}
|
61844
|
-
|
61845
|
-
_params: Dict[str, Any] = {
|
61846
|
-
}
|
61908
|
+
class themes_api_ChartTheme(ConjureBeanType):
|
61847
61909
|
|
61848
|
-
|
61910
|
+
@builtins.classmethod
|
61911
|
+
def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
|
61912
|
+
return {
|
61913
|
+
'rid': ConjureFieldDefinition('rid', themes_api_ChartThemeRid),
|
61914
|
+
'name': ConjureFieldDefinition('name', str),
|
61915
|
+
'created_by': ConjureFieldDefinition('createdBy', str),
|
61916
|
+
'created_at': ConjureFieldDefinition('createdAt', str),
|
61917
|
+
'updated_by': ConjureFieldDefinition('updatedBy', OptionalTypeWrapper[str]),
|
61918
|
+
'updated_at': ConjureFieldDefinition('updatedAt', OptionalTypeWrapper[str]),
|
61919
|
+
'content': ConjureFieldDefinition('content', themes_api_ChartThemeContent)
|
61849
61920
|
}
|
61850
61921
|
|
61851
|
-
|
61852
|
-
|
61853
|
-
_path = '/timeseries/archetype/v1/series-archetype/batch-get'
|
61854
|
-
_path = _path.format(**_path_params)
|
61855
|
-
|
61856
|
-
_response: Response = self._request(
|
61857
|
-
'POST',
|
61858
|
-
self._uri + _path,
|
61859
|
-
params=_params,
|
61860
|
-
headers=_headers,
|
61861
|
-
json=_json)
|
61922
|
+
__slots__: List[str] = ['_rid', '_name', '_created_by', '_created_at', '_updated_by', '_updated_at', '_content']
|
61862
61923
|
|
61863
|
-
|
61864
|
-
|
61924
|
+
def __init__(self, content: "themes_api_ChartThemeContent", created_at: str, created_by: str, name: str, rid: str, updated_at: Optional[str] = None, updated_by: Optional[str] = None) -> None:
|
61925
|
+
self._rid = rid
|
61926
|
+
self._name = name
|
61927
|
+
self._created_by = created_by
|
61928
|
+
self._created_at = created_at
|
61929
|
+
self._updated_by = updated_by
|
61930
|
+
self._updated_at = updated_at
|
61931
|
+
self._content = content
|
61865
61932
|
|
61866
|
-
|
61933
|
+
@builtins.property
|
61934
|
+
def rid(self) -> str:
|
61867
61935
|
"""
|
61868
|
-
|
61936
|
+
Unique resource identifier for the theme.
|
61869
61937
|
"""
|
61938
|
+
return self._rid
|
61870
61939
|
|
61871
|
-
|
61872
|
-
|
61873
|
-
'Content-Type': 'application/json',
|
61874
|
-
'Authorization': auth_header,
|
61875
|
-
}
|
61876
|
-
|
61877
|
-
_params: Dict[str, Any] = {
|
61878
|
-
}
|
61879
|
-
|
61880
|
-
_path_params: Dict[str, Any] = {
|
61881
|
-
}
|
61882
|
-
|
61883
|
-
_json: Any = ConjureEncoder().default(request)
|
61884
|
-
|
61885
|
-
_path = '/timeseries/archetype/v1/series-archetype'
|
61886
|
-
_path = _path.format(**_path_params)
|
61887
|
-
|
61888
|
-
_response: Response = self._request(
|
61889
|
-
'POST',
|
61890
|
-
self._uri + _path,
|
61891
|
-
params=_params,
|
61892
|
-
headers=_headers,
|
61893
|
-
json=_json)
|
61894
|
-
|
61895
|
-
return
|
61896
|
-
|
61897
|
-
def batch_create(self, auth_header: str, request: "timeseries_archetype_api_BatchCreateSeriesArchetypeRequest") -> None:
|
61940
|
+
@builtins.property
|
61941
|
+
def name(self) -> str:
|
61898
61942
|
"""
|
61899
|
-
|
61943
|
+
The name of the theme as defined by the user.
|
61900
61944
|
"""
|
61945
|
+
return self._name
|
61901
61946
|
|
61902
|
-
|
61903
|
-
|
61904
|
-
|
61905
|
-
|
61906
|
-
|
61907
|
-
|
61908
|
-
_params: Dict[str, Any] = {
|
61909
|
-
}
|
61910
|
-
|
61911
|
-
_path_params: Dict[str, Any] = {
|
61912
|
-
}
|
61913
|
-
|
61914
|
-
_json: Any = ConjureEncoder().default(request)
|
61947
|
+
@builtins.property
|
61948
|
+
def created_by(self) -> str:
|
61949
|
+
"""
|
61950
|
+
The rid of the user who first created the theme.
|
61951
|
+
"""
|
61952
|
+
return self._created_by
|
61915
61953
|
|
61916
|
-
|
61917
|
-
|
61954
|
+
@builtins.property
|
61955
|
+
def created_at(self) -> str:
|
61956
|
+
"""
|
61957
|
+
The time the theme was created.
|
61958
|
+
"""
|
61959
|
+
return self._created_at
|
61918
61960
|
|
61919
|
-
|
61920
|
-
|
61921
|
-
|
61922
|
-
|
61923
|
-
|
61924
|
-
|
61961
|
+
@builtins.property
|
61962
|
+
def updated_by(self) -> Optional[str]:
|
61963
|
+
"""
|
61964
|
+
The rid of the user who last updated the theme.
|
61965
|
+
"""
|
61966
|
+
return self._updated_by
|
61925
61967
|
|
61926
|
-
|
61968
|
+
@builtins.property
|
61969
|
+
def updated_at(self) -> Optional[str]:
|
61970
|
+
"""
|
61971
|
+
The rid of the user who last updated the theme.
|
61972
|
+
"""
|
61973
|
+
return self._updated_at
|
61927
61974
|
|
61928
|
-
|
61975
|
+
@builtins.property
|
61976
|
+
def content(self) -> "themes_api_ChartThemeContent":
|
61929
61977
|
"""
|
61930
|
-
|
61978
|
+
Specifies the chart theme styling (e.g. font, legends, axes)
|
61931
61979
|
"""
|
61980
|
+
return self._content
|
61932
61981
|
|
61933
|
-
_headers: Dict[str, Any] = {
|
61934
|
-
'Accept': 'application/json',
|
61935
|
-
'Authorization': auth_header,
|
61936
|
-
}
|
61937
61982
|
|
61938
|
-
|
61939
|
-
|
61983
|
+
themes_api_ChartTheme.__name__ = "ChartTheme"
|
61984
|
+
themes_api_ChartTheme.__qualname__ = "ChartTheme"
|
61985
|
+
themes_api_ChartTheme.__module__ = "nominal_api.themes_api"
|
61940
61986
|
|
61941
|
-
_path_params: Dict[str, Any] = {
|
61942
|
-
'rid': rid,
|
61943
|
-
}
|
61944
61987
|
|
61945
|
-
|
61988
|
+
class themes_api_ChartThemeContent(ConjureUnionType):
|
61989
|
+
_v1: Optional["themes_api_ChartThemeContentV1"] = None
|
61946
61990
|
|
61947
|
-
|
61948
|
-
|
61991
|
+
@builtins.classmethod
|
61992
|
+
def _options(cls) -> Dict[str, ConjureFieldDefinition]:
|
61993
|
+
return {
|
61994
|
+
'v1': ConjureFieldDefinition('v1', themes_api_ChartThemeContentV1)
|
61995
|
+
}
|
61949
61996
|
|
61950
|
-
|
61951
|
-
|
61952
|
-
|
61953
|
-
|
61954
|
-
|
61955
|
-
|
61997
|
+
def __init__(
|
61998
|
+
self,
|
61999
|
+
v1: Optional["themes_api_ChartThemeContentV1"] = None,
|
62000
|
+
type_of_union: Optional[str] = None
|
62001
|
+
) -> None:
|
62002
|
+
if type_of_union is None:
|
62003
|
+
if (v1 is not None) != 1:
|
62004
|
+
raise ValueError('a union must contain a single member')
|
61956
62005
|
|
61957
|
-
|
61958
|
-
|
62006
|
+
if v1 is not None:
|
62007
|
+
self._v1 = v1
|
62008
|
+
self._type = 'v1'
|
61959
62009
|
|
61960
|
-
|
61961
|
-
|
61962
|
-
|
61963
|
-
|
61964
|
-
|
62010
|
+
elif type_of_union == 'v1':
|
62011
|
+
if v1 is None:
|
62012
|
+
raise ValueError('a union value must not be None')
|
62013
|
+
self._v1 = v1
|
62014
|
+
self._type = 'v1'
|
61965
62015
|
|
61966
|
-
|
61967
|
-
|
61968
|
-
|
61969
|
-
'Authorization': auth_header,
|
61970
|
-
}
|
62016
|
+
@builtins.property
|
62017
|
+
def v1(self) -> Optional["themes_api_ChartThemeContentV1"]:
|
62018
|
+
return self._v1
|
61971
62019
|
|
61972
|
-
|
61973
|
-
|
62020
|
+
def accept(self, visitor) -> Any:
|
62021
|
+
if not isinstance(visitor, themes_api_ChartThemeContentVisitor):
|
62022
|
+
raise ValueError('{} is not an instance of themes_api_ChartThemeContentVisitor'.format(visitor.__class__.__name__))
|
62023
|
+
if self._type == 'v1' and self.v1 is not None:
|
62024
|
+
return visitor._v1(self.v1)
|
61974
62025
|
|
61975
|
-
_path_params: Dict[str, Any] = {
|
61976
|
-
'rid': rid,
|
61977
|
-
}
|
61978
62026
|
|
61979
|
-
|
62027
|
+
themes_api_ChartThemeContent.__name__ = "ChartThemeContent"
|
62028
|
+
themes_api_ChartThemeContent.__qualname__ = "ChartThemeContent"
|
62029
|
+
themes_api_ChartThemeContent.__module__ = "nominal_api.themes_api"
|
61980
62030
|
|
61981
|
-
_path = '/timeseries/archetype/v1/series-archetype/{rid}/metadata'
|
61982
|
-
_path = _path.format(**_path_params)
|
61983
62031
|
|
61984
|
-
|
61985
|
-
'POST',
|
61986
|
-
self._uri + _path,
|
61987
|
-
params=_params,
|
61988
|
-
headers=_headers,
|
61989
|
-
json=_json)
|
62032
|
+
class themes_api_ChartThemeContentVisitor:
|
61990
62033
|
|
61991
|
-
|
61992
|
-
|
62034
|
+
@abstractmethod
|
62035
|
+
def _v1(self, v1: "themes_api_ChartThemeContentV1") -> Any:
|
62036
|
+
pass
|
61993
62037
|
|
61994
62038
|
|
61995
|
-
|
61996
|
-
|
61997
|
-
|
62039
|
+
themes_api_ChartThemeContentVisitor.__name__ = "ChartThemeContentVisitor"
|
62040
|
+
themes_api_ChartThemeContentVisitor.__qualname__ = "ChartThemeContentVisitor"
|
62041
|
+
themes_api_ChartThemeContentVisitor.__module__ = "nominal_api.themes_api"
|
61998
62042
|
|
61999
62043
|
|
62000
|
-
class
|
62044
|
+
class themes_api_ChartThemeContentV1(ConjureBeanType):
|
62001
62045
|
|
62002
62046
|
@builtins.classmethod
|
62003
62047
|
def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
|
62004
62048
|
return {
|
62005
|
-
'
|
62049
|
+
'title_enabled': ConjureFieldDefinition('titleEnabled', bool),
|
62050
|
+
'title_alignment': ConjureFieldDefinition('titleAlignment', themes_api_TextAlignment),
|
62051
|
+
'title_font_size': ConjureFieldDefinition('titleFontSize', int),
|
62052
|
+
'title_font_color': ConjureFieldDefinition('titleFontColor', themes_api_HexColor),
|
62053
|
+
'caption_enabled': ConjureFieldDefinition('captionEnabled', bool),
|
62054
|
+
'caption_alignment': ConjureFieldDefinition('captionAlignment', themes_api_TextAlignment),
|
62055
|
+
'caption_font_size': ConjureFieldDefinition('captionFontSize', int),
|
62056
|
+
'caption_font_color': ConjureFieldDefinition('captionFontColor', themes_api_HexColor),
|
62057
|
+
'background_enabled': ConjureFieldDefinition('backgroundEnabled', bool),
|
62058
|
+
'legend_enabled': ConjureFieldDefinition('legendEnabled', bool),
|
62059
|
+
'legend_position': ConjureFieldDefinition('legendPosition', themes_api_LegendPosition),
|
62060
|
+
'legend_font_size': ConjureFieldDefinition('legendFontSize', int),
|
62061
|
+
'legend_font_color': ConjureFieldDefinition('legendFontColor', themes_api_HexColor),
|
62062
|
+
'aspect_ratio_width': ConjureFieldDefinition('aspectRatioWidth', int),
|
62063
|
+
'aspect_ratio_height': ConjureFieldDefinition('aspectRatioHeight', int),
|
62064
|
+
'chart_type_themes': ConjureFieldDefinition('chartTypeThemes', themes_api_ChartTypeThemes)
|
62006
62065
|
}
|
62007
62066
|
|
62008
|
-
__slots__: List[str] = ['
|
62067
|
+
__slots__: List[str] = ['_title_enabled', '_title_alignment', '_title_font_size', '_title_font_color', '_caption_enabled', '_caption_alignment', '_caption_font_size', '_caption_font_color', '_background_enabled', '_legend_enabled', '_legend_position', '_legend_font_size', '_legend_font_color', '_aspect_ratio_width', '_aspect_ratio_height', '_chart_type_themes']
|
62009
62068
|
|
62010
|
-
def __init__(self,
|
62011
|
-
self.
|
62069
|
+
def __init__(self, aspect_ratio_height: int, aspect_ratio_width: int, background_enabled: bool, caption_alignment: "themes_api_TextAlignment", caption_enabled: bool, caption_font_color: str, caption_font_size: int, chart_type_themes: "themes_api_ChartTypeThemes", legend_enabled: bool, legend_font_color: str, legend_font_size: int, legend_position: "themes_api_LegendPosition", title_alignment: "themes_api_TextAlignment", title_enabled: bool, title_font_color: str, title_font_size: int) -> None:
|
62070
|
+
self._title_enabled = title_enabled
|
62071
|
+
self._title_alignment = title_alignment
|
62072
|
+
self._title_font_size = title_font_size
|
62073
|
+
self._title_font_color = title_font_color
|
62074
|
+
self._caption_enabled = caption_enabled
|
62075
|
+
self._caption_alignment = caption_alignment
|
62076
|
+
self._caption_font_size = caption_font_size
|
62077
|
+
self._caption_font_color = caption_font_color
|
62078
|
+
self._background_enabled = background_enabled
|
62079
|
+
self._legend_enabled = legend_enabled
|
62080
|
+
self._legend_position = legend_position
|
62081
|
+
self._legend_font_size = legend_font_size
|
62082
|
+
self._legend_font_color = legend_font_color
|
62083
|
+
self._aspect_ratio_width = aspect_ratio_width
|
62084
|
+
self._aspect_ratio_height = aspect_ratio_height
|
62085
|
+
self._chart_type_themes = chart_type_themes
|
62012
62086
|
|
62013
62087
|
@builtins.property
|
62014
|
-
def
|
62015
|
-
|
62088
|
+
def title_enabled(self) -> bool:
|
62089
|
+
"""
|
62090
|
+
Whether to show a title in the export.
|
62091
|
+
"""
|
62092
|
+
return self._title_enabled
|
62016
62093
|
|
62094
|
+
@builtins.property
|
62095
|
+
def title_alignment(self) -> "themes_api_TextAlignment":
|
62096
|
+
"""
|
62097
|
+
How to align the text of the title.
|
62098
|
+
"""
|
62099
|
+
return self._title_alignment
|
62017
62100
|
|
62018
|
-
|
62101
|
+
@builtins.property
|
62102
|
+
def title_font_size(self) -> int:
|
62103
|
+
"""
|
62104
|
+
Font size of the title.
|
62105
|
+
"""
|
62106
|
+
return self._title_font_size
|
62107
|
+
|
62108
|
+
@builtins.property
|
62109
|
+
def title_font_color(self) -> str:
|
62110
|
+
"""
|
62111
|
+
Font color of the title.
|
62112
|
+
"""
|
62113
|
+
return self._title_font_color
|
62114
|
+
|
62115
|
+
@builtins.property
|
62116
|
+
def caption_enabled(self) -> bool:
|
62117
|
+
"""
|
62118
|
+
Whether to show a caption in the export.
|
62119
|
+
"""
|
62120
|
+
return self._caption_enabled
|
62121
|
+
|
62122
|
+
@builtins.property
|
62123
|
+
def caption_alignment(self) -> "themes_api_TextAlignment":
|
62124
|
+
"""
|
62125
|
+
How to align the text of the caption.
|
62126
|
+
"""
|
62127
|
+
return self._caption_alignment
|
62128
|
+
|
62129
|
+
@builtins.property
|
62130
|
+
def caption_font_size(self) -> int:
|
62131
|
+
"""
|
62132
|
+
Font size of the caption.
|
62133
|
+
"""
|
62134
|
+
return self._caption_font_size
|
62135
|
+
|
62136
|
+
@builtins.property
|
62137
|
+
def caption_font_color(self) -> str:
|
62138
|
+
"""
|
62139
|
+
Font color of the caption.
|
62140
|
+
"""
|
62141
|
+
return self._caption_font_color
|
62142
|
+
|
62143
|
+
@builtins.property
|
62144
|
+
def background_enabled(self) -> bool:
|
62145
|
+
"""
|
62146
|
+
Whether to include a default background with the export.
|
62147
|
+
(`false` indicates that the background should be transparent)
|
62148
|
+
"""
|
62149
|
+
return self._background_enabled
|
62150
|
+
|
62151
|
+
@builtins.property
|
62152
|
+
def legend_enabled(self) -> bool:
|
62153
|
+
"""
|
62154
|
+
Whether to include a legend in the export.
|
62155
|
+
"""
|
62156
|
+
return self._legend_enabled
|
62157
|
+
|
62158
|
+
@builtins.property
|
62159
|
+
def legend_position(self) -> "themes_api_LegendPosition":
|
62160
|
+
"""
|
62161
|
+
Which side the legend should appear on.
|
62162
|
+
"""
|
62163
|
+
return self._legend_position
|
62164
|
+
|
62165
|
+
@builtins.property
|
62166
|
+
def legend_font_size(self) -> int:
|
62167
|
+
"""
|
62168
|
+
Font size of the legend.
|
62169
|
+
"""
|
62170
|
+
return self._legend_font_size
|
62171
|
+
|
62172
|
+
@builtins.property
|
62173
|
+
def legend_font_color(self) -> str:
|
62174
|
+
"""
|
62175
|
+
Font color of the legend.
|
62176
|
+
"""
|
62177
|
+
return self._legend_font_color
|
62178
|
+
|
62179
|
+
@builtins.property
|
62180
|
+
def aspect_ratio_width(self) -> int:
|
62181
|
+
"""
|
62182
|
+
The relative width of the chart export.
|
62183
|
+
"""
|
62184
|
+
return self._aspect_ratio_width
|
62185
|
+
|
62186
|
+
@builtins.property
|
62187
|
+
def aspect_ratio_height(self) -> int:
|
62188
|
+
"""
|
62189
|
+
The relative height of the chart export.
|
62190
|
+
"""
|
62191
|
+
return self._aspect_ratio_height
|
62192
|
+
|
62193
|
+
@builtins.property
|
62194
|
+
def chart_type_themes(self) -> "themes_api_ChartTypeThemes":
|
62195
|
+
"""
|
62196
|
+
Theme parameters specific to chart types.
|
62197
|
+
"""
|
62198
|
+
return self._chart_type_themes
|
62199
|
+
|
62200
|
+
|
62201
|
+
themes_api_ChartThemeContentV1.__name__ = "ChartThemeContentV1"
|
62202
|
+
themes_api_ChartThemeContentV1.__qualname__ = "ChartThemeContentV1"
|
62203
|
+
themes_api_ChartThemeContentV1.__module__ = "nominal_api.themes_api"
|
62204
|
+
|
62205
|
+
|
62206
|
+
class themes_api_ChartTypeThemes(ConjureBeanType):
|
62207
|
+
"""
|
62208
|
+
Theme parameters specific to chart types.
|
62209
|
+
"""
|
62210
|
+
|
62211
|
+
@builtins.classmethod
|
62212
|
+
def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
|
62213
|
+
return {
|
62214
|
+
'time_series': ConjureFieldDefinition('timeSeries', themes_api_TimeSeriesChartTheme)
|
62215
|
+
}
|
62216
|
+
|
62217
|
+
__slots__: List[str] = ['_time_series']
|
62218
|
+
|
62219
|
+
def __init__(self, time_series: "themes_api_TimeSeriesChartTheme") -> None:
|
62220
|
+
self._time_series = time_series
|
62221
|
+
|
62222
|
+
@builtins.property
|
62223
|
+
def time_series(self) -> "themes_api_TimeSeriesChartTheme":
|
62224
|
+
"""
|
62225
|
+
The theme specific to parameters of the time series chart.
|
62226
|
+
"""
|
62227
|
+
return self._time_series
|
62228
|
+
|
62229
|
+
|
62230
|
+
themes_api_ChartTypeThemes.__name__ = "ChartTypeThemes"
|
62231
|
+
themes_api_ChartTypeThemes.__qualname__ = "ChartTypeThemes"
|
62232
|
+
themes_api_ChartTypeThemes.__module__ = "nominal_api.themes_api"
|
62233
|
+
|
62234
|
+
|
62235
|
+
class themes_api_CreateChartThemeRequest(ConjureBeanType):
|
62236
|
+
|
62237
|
+
@builtins.classmethod
|
62238
|
+
def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
|
62239
|
+
return {
|
62240
|
+
'name': ConjureFieldDefinition('name', str),
|
62241
|
+
'content': ConjureFieldDefinition('content', themes_api_ChartThemeContent)
|
62242
|
+
}
|
62243
|
+
|
62244
|
+
__slots__: List[str] = ['_name', '_content']
|
62245
|
+
|
62246
|
+
def __init__(self, content: "themes_api_ChartThemeContent", name: str) -> None:
|
62247
|
+
self._name = name
|
62248
|
+
self._content = content
|
62249
|
+
|
62250
|
+
@builtins.property
|
62251
|
+
def name(self) -> str:
|
62252
|
+
"""
|
62253
|
+
The name of the theme.
|
62254
|
+
"""
|
62255
|
+
return self._name
|
62256
|
+
|
62257
|
+
@builtins.property
|
62258
|
+
def content(self) -> "themes_api_ChartThemeContent":
|
62259
|
+
"""
|
62260
|
+
The theme fields.
|
62261
|
+
"""
|
62262
|
+
return self._content
|
62263
|
+
|
62264
|
+
|
62265
|
+
themes_api_CreateChartThemeRequest.__name__ = "CreateChartThemeRequest"
|
62266
|
+
themes_api_CreateChartThemeRequest.__qualname__ = "CreateChartThemeRequest"
|
62267
|
+
themes_api_CreateChartThemeRequest.__module__ = "nominal_api.themes_api"
|
62268
|
+
|
62269
|
+
|
62270
|
+
class themes_api_LegendPosition(ConjureEnumType):
|
62271
|
+
|
62272
|
+
TOP = 'TOP'
|
62273
|
+
'''TOP'''
|
62274
|
+
BOTTOM = 'BOTTOM'
|
62275
|
+
'''BOTTOM'''
|
62276
|
+
LEFT = 'LEFT'
|
62277
|
+
'''LEFT'''
|
62278
|
+
RIGHT = 'RIGHT'
|
62279
|
+
'''RIGHT'''
|
62280
|
+
UNKNOWN = 'UNKNOWN'
|
62281
|
+
'''UNKNOWN'''
|
62282
|
+
|
62283
|
+
def __reduce_ex__(self, proto):
|
62284
|
+
return self.__class__, (self.name,)
|
62285
|
+
|
62286
|
+
|
62287
|
+
themes_api_LegendPosition.__name__ = "LegendPosition"
|
62288
|
+
themes_api_LegendPosition.__qualname__ = "LegendPosition"
|
62289
|
+
themes_api_LegendPosition.__module__ = "nominal_api.themes_api"
|
62290
|
+
|
62291
|
+
|
62292
|
+
class themes_api_TextAlignment(ConjureEnumType):
|
62293
|
+
|
62294
|
+
START = 'START'
|
62295
|
+
'''START'''
|
62296
|
+
END = 'END'
|
62297
|
+
'''END'''
|
62298
|
+
CENTER = 'CENTER'
|
62299
|
+
'''CENTER'''
|
62300
|
+
JUSTIFY = 'JUSTIFY'
|
62301
|
+
'''JUSTIFY'''
|
62302
|
+
UNKNOWN = 'UNKNOWN'
|
62303
|
+
'''UNKNOWN'''
|
62304
|
+
|
62305
|
+
def __reduce_ex__(self, proto):
|
62306
|
+
return self.__class__, (self.name,)
|
62307
|
+
|
62308
|
+
|
62309
|
+
themes_api_TextAlignment.__name__ = "TextAlignment"
|
62310
|
+
themes_api_TextAlignment.__qualname__ = "TextAlignment"
|
62311
|
+
themes_api_TextAlignment.__module__ = "nominal_api.themes_api"
|
62312
|
+
|
62313
|
+
|
62314
|
+
class themes_api_TextDirection(ConjureEnumType):
|
62315
|
+
|
62316
|
+
HORIZONTAL = 'HORIZONTAL'
|
62317
|
+
'''HORIZONTAL'''
|
62318
|
+
VERTICAL = 'VERTICAL'
|
62319
|
+
'''VERTICAL'''
|
62320
|
+
UNKNOWN = 'UNKNOWN'
|
62321
|
+
'''UNKNOWN'''
|
62322
|
+
|
62323
|
+
def __reduce_ex__(self, proto):
|
62324
|
+
return self.__class__, (self.name,)
|
62325
|
+
|
62326
|
+
|
62327
|
+
themes_api_TextDirection.__name__ = "TextDirection"
|
62328
|
+
themes_api_TextDirection.__qualname__ = "TextDirection"
|
62329
|
+
themes_api_TextDirection.__module__ = "nominal_api.themes_api"
|
62330
|
+
|
62331
|
+
|
62332
|
+
class themes_api_ThemesService(Service):
|
62333
|
+
"""
|
62334
|
+
Themes service manages themes for exporting charts.
|
62335
|
+
"""
|
62336
|
+
|
62337
|
+
def list_chart_themes(self, auth_header: str) -> List["themes_api_ChartTheme"]:
|
62338
|
+
"""
|
62339
|
+
Get all chart themes saved to the user's organization.
|
62340
|
+
"""
|
62341
|
+
|
62342
|
+
_headers: Dict[str, Any] = {
|
62343
|
+
'Accept': 'application/json',
|
62344
|
+
'Authorization': auth_header,
|
62345
|
+
}
|
62346
|
+
|
62347
|
+
_params: Dict[str, Any] = {
|
62348
|
+
}
|
62349
|
+
|
62350
|
+
_path_params: Dict[str, Any] = {
|
62351
|
+
}
|
62352
|
+
|
62353
|
+
_json: Any = None
|
62354
|
+
|
62355
|
+
_path = '/themes/v1/chart-themes'
|
62356
|
+
_path = _path.format(**_path_params)
|
62357
|
+
|
62358
|
+
_response: Response = self._request(
|
62359
|
+
'GET',
|
62360
|
+
self._uri + _path,
|
62361
|
+
params=_params,
|
62362
|
+
headers=_headers,
|
62363
|
+
json=_json)
|
62364
|
+
|
62365
|
+
_decoder = ConjureDecoder()
|
62366
|
+
return _decoder.decode(_response.json(), List[themes_api_ChartTheme], self._return_none_for_unknown_union_types)
|
62367
|
+
|
62368
|
+
def get_chart_theme(self, auth_header: str, chart_theme_rid: str) -> "themes_api_ChartTheme":
|
62369
|
+
"""
|
62370
|
+
Get a specific chart theme by RID.
|
62371
|
+
"""
|
62372
|
+
|
62373
|
+
_headers: Dict[str, Any] = {
|
62374
|
+
'Accept': 'application/json',
|
62375
|
+
'Authorization': auth_header,
|
62376
|
+
}
|
62377
|
+
|
62378
|
+
_params: Dict[str, Any] = {
|
62379
|
+
}
|
62380
|
+
|
62381
|
+
_path_params: Dict[str, Any] = {
|
62382
|
+
'chartThemeRid': chart_theme_rid,
|
62383
|
+
}
|
62384
|
+
|
62385
|
+
_json: Any = None
|
62386
|
+
|
62387
|
+
_path = '/themes/v1/chart-themes/{chartThemeRid}'
|
62388
|
+
_path = _path.format(**_path_params)
|
62389
|
+
|
62390
|
+
_response: Response = self._request(
|
62391
|
+
'GET',
|
62392
|
+
self._uri + _path,
|
62393
|
+
params=_params,
|
62394
|
+
headers=_headers,
|
62395
|
+
json=_json)
|
62396
|
+
|
62397
|
+
_decoder = ConjureDecoder()
|
62398
|
+
return _decoder.decode(_response.json(), themes_api_ChartTheme, self._return_none_for_unknown_union_types)
|
62399
|
+
|
62400
|
+
def create_chart_theme(self, auth_header: str, request: "themes_api_CreateChartThemeRequest") -> "themes_api_ChartTheme":
|
62401
|
+
"""
|
62402
|
+
Create a new chart theme.
|
62403
|
+
"""
|
62404
|
+
|
62405
|
+
_headers: Dict[str, Any] = {
|
62406
|
+
'Accept': 'application/json',
|
62407
|
+
'Content-Type': 'application/json',
|
62408
|
+
'Authorization': auth_header,
|
62409
|
+
}
|
62410
|
+
|
62411
|
+
_params: Dict[str, Any] = {
|
62412
|
+
}
|
62413
|
+
|
62414
|
+
_path_params: Dict[str, Any] = {
|
62415
|
+
}
|
62416
|
+
|
62417
|
+
_json: Any = ConjureEncoder().default(request)
|
62418
|
+
|
62419
|
+
_path = '/themes/v1/chart-themes'
|
62420
|
+
_path = _path.format(**_path_params)
|
62421
|
+
|
62422
|
+
_response: Response = self._request(
|
62423
|
+
'POST',
|
62424
|
+
self._uri + _path,
|
62425
|
+
params=_params,
|
62426
|
+
headers=_headers,
|
62427
|
+
json=_json)
|
62428
|
+
|
62429
|
+
_decoder = ConjureDecoder()
|
62430
|
+
return _decoder.decode(_response.json(), themes_api_ChartTheme, self._return_none_for_unknown_union_types)
|
62431
|
+
|
62432
|
+
def update_chart_theme(self, auth_header: str, chart_theme_rid: str, request: "themes_api_UpdateChartThemeRequest") -> "themes_api_ChartTheme":
|
62433
|
+
"""
|
62434
|
+
Update an existing chart theme.
|
62435
|
+
"""
|
62436
|
+
|
62437
|
+
_headers: Dict[str, Any] = {
|
62438
|
+
'Accept': 'application/json',
|
62439
|
+
'Content-Type': 'application/json',
|
62440
|
+
'Authorization': auth_header,
|
62441
|
+
}
|
62442
|
+
|
62443
|
+
_params: Dict[str, Any] = {
|
62444
|
+
}
|
62445
|
+
|
62446
|
+
_path_params: Dict[str, Any] = {
|
62447
|
+
'chartThemeRid': chart_theme_rid,
|
62448
|
+
}
|
62449
|
+
|
62450
|
+
_json: Any = ConjureEncoder().default(request)
|
62451
|
+
|
62452
|
+
_path = '/themes/v1/chart-themes/{chartThemeRid}'
|
62453
|
+
_path = _path.format(**_path_params)
|
62454
|
+
|
62455
|
+
_response: Response = self._request(
|
62456
|
+
'PUT',
|
62457
|
+
self._uri + _path,
|
62458
|
+
params=_params,
|
62459
|
+
headers=_headers,
|
62460
|
+
json=_json)
|
62461
|
+
|
62462
|
+
_decoder = ConjureDecoder()
|
62463
|
+
return _decoder.decode(_response.json(), themes_api_ChartTheme, self._return_none_for_unknown_union_types)
|
62464
|
+
|
62465
|
+
def delete_chart_theme(self, auth_header: str, chart_theme_rid: str) -> None:
|
62466
|
+
"""
|
62467
|
+
Delete an existing comment.
|
62468
|
+
"""
|
62469
|
+
|
62470
|
+
_headers: Dict[str, Any] = {
|
62471
|
+
'Accept': 'application/json',
|
62472
|
+
'Authorization': auth_header,
|
62473
|
+
}
|
62474
|
+
|
62475
|
+
_params: Dict[str, Any] = {
|
62476
|
+
}
|
62477
|
+
|
62478
|
+
_path_params: Dict[str, Any] = {
|
62479
|
+
'chartThemeRid': chart_theme_rid,
|
62480
|
+
}
|
62481
|
+
|
62482
|
+
_json: Any = None
|
62483
|
+
|
62484
|
+
_path = '/themes/v1/chart-themes/{chartThemeRid}'
|
62485
|
+
_path = _path.format(**_path_params)
|
62486
|
+
|
62487
|
+
_response: Response = self._request(
|
62488
|
+
'DELETE',
|
62489
|
+
self._uri + _path,
|
62490
|
+
params=_params,
|
62491
|
+
headers=_headers,
|
62492
|
+
json=_json)
|
62493
|
+
|
62494
|
+
return
|
62495
|
+
|
62496
|
+
|
62497
|
+
themes_api_ThemesService.__name__ = "ThemesService"
|
62498
|
+
themes_api_ThemesService.__qualname__ = "ThemesService"
|
62499
|
+
themes_api_ThemesService.__module__ = "nominal_api.themes_api"
|
62500
|
+
|
62501
|
+
|
62502
|
+
class themes_api_TimeSeriesChartTheme(ConjureUnionType):
|
62503
|
+
_v1: Optional["themes_api_TimeSeriesChartThemeV1"] = None
|
62504
|
+
|
62505
|
+
@builtins.classmethod
|
62506
|
+
def _options(cls) -> Dict[str, ConjureFieldDefinition]:
|
62507
|
+
return {
|
62508
|
+
'v1': ConjureFieldDefinition('v1', themes_api_TimeSeriesChartThemeV1)
|
62509
|
+
}
|
62510
|
+
|
62511
|
+
def __init__(
|
62512
|
+
self,
|
62513
|
+
v1: Optional["themes_api_TimeSeriesChartThemeV1"] = None,
|
62514
|
+
type_of_union: Optional[str] = None
|
62515
|
+
) -> None:
|
62516
|
+
if type_of_union is None:
|
62517
|
+
if (v1 is not None) != 1:
|
62518
|
+
raise ValueError('a union must contain a single member')
|
62519
|
+
|
62520
|
+
if v1 is not None:
|
62521
|
+
self._v1 = v1
|
62522
|
+
self._type = 'v1'
|
62523
|
+
|
62524
|
+
elif type_of_union == 'v1':
|
62525
|
+
if v1 is None:
|
62526
|
+
raise ValueError('a union value must not be None')
|
62527
|
+
self._v1 = v1
|
62528
|
+
self._type = 'v1'
|
62529
|
+
|
62530
|
+
@builtins.property
|
62531
|
+
def v1(self) -> Optional["themes_api_TimeSeriesChartThemeV1"]:
|
62532
|
+
return self._v1
|
62533
|
+
|
62534
|
+
def accept(self, visitor) -> Any:
|
62535
|
+
if not isinstance(visitor, themes_api_TimeSeriesChartThemeVisitor):
|
62536
|
+
raise ValueError('{} is not an instance of themes_api_TimeSeriesChartThemeVisitor'.format(visitor.__class__.__name__))
|
62537
|
+
if self._type == 'v1' and self.v1 is not None:
|
62538
|
+
return visitor._v1(self.v1)
|
62539
|
+
|
62540
|
+
|
62541
|
+
themes_api_TimeSeriesChartTheme.__name__ = "TimeSeriesChartTheme"
|
62542
|
+
themes_api_TimeSeriesChartTheme.__qualname__ = "TimeSeriesChartTheme"
|
62543
|
+
themes_api_TimeSeriesChartTheme.__module__ = "nominal_api.themes_api"
|
62544
|
+
|
62545
|
+
|
62546
|
+
class themes_api_TimeSeriesChartThemeVisitor:
|
62547
|
+
|
62548
|
+
@abstractmethod
|
62549
|
+
def _v1(self, v1: "themes_api_TimeSeriesChartThemeV1") -> Any:
|
62550
|
+
pass
|
62551
|
+
|
62552
|
+
|
62553
|
+
themes_api_TimeSeriesChartThemeVisitor.__name__ = "TimeSeriesChartThemeVisitor"
|
62554
|
+
themes_api_TimeSeriesChartThemeVisitor.__qualname__ = "TimeSeriesChartThemeVisitor"
|
62555
|
+
themes_api_TimeSeriesChartThemeVisitor.__module__ = "nominal_api.themes_api"
|
62556
|
+
|
62557
|
+
|
62558
|
+
class themes_api_TimeSeriesChartThemeV1(ConjureBeanType):
|
62559
|
+
"""
|
62560
|
+
Theme parameters specific to the time series chart.
|
62561
|
+
"""
|
62562
|
+
|
62563
|
+
@builtins.classmethod
|
62564
|
+
def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
|
62565
|
+
return {
|
62566
|
+
'x_axis_tick_font_size': ConjureFieldDefinition('xAxisTickFontSize', int),
|
62567
|
+
'x_axis_tick_font_color': ConjureFieldDefinition('xAxisTickFontColor', themes_api_HexColor),
|
62568
|
+
'y_axis_title_font_size': ConjureFieldDefinition('yAxisTitleFontSize', int),
|
62569
|
+
'y_axis_tick_font_size': ConjureFieldDefinition('yAxisTickFontSize', int)
|
62570
|
+
}
|
62571
|
+
|
62572
|
+
__slots__: List[str] = ['_x_axis_tick_font_size', '_x_axis_tick_font_color', '_y_axis_title_font_size', '_y_axis_tick_font_size']
|
62573
|
+
|
62574
|
+
def __init__(self, x_axis_tick_font_color: str, x_axis_tick_font_size: int, y_axis_tick_font_size: int, y_axis_title_font_size: int) -> None:
|
62575
|
+
self._x_axis_tick_font_size = x_axis_tick_font_size
|
62576
|
+
self._x_axis_tick_font_color = x_axis_tick_font_color
|
62577
|
+
self._y_axis_title_font_size = y_axis_title_font_size
|
62578
|
+
self._y_axis_tick_font_size = y_axis_tick_font_size
|
62579
|
+
|
62580
|
+
@builtins.property
|
62581
|
+
def x_axis_tick_font_size(self) -> int:
|
62582
|
+
"""
|
62583
|
+
The font size of the x-axis ticks.
|
62584
|
+
"""
|
62585
|
+
return self._x_axis_tick_font_size
|
62586
|
+
|
62587
|
+
@builtins.property
|
62588
|
+
def x_axis_tick_font_color(self) -> str:
|
62589
|
+
"""
|
62590
|
+
The font color of the x-axis ticks.
|
62591
|
+
"""
|
62592
|
+
return self._x_axis_tick_font_color
|
62593
|
+
|
62594
|
+
@builtins.property
|
62595
|
+
def y_axis_title_font_size(self) -> int:
|
62596
|
+
"""
|
62597
|
+
The font size of the y-axis labels.
|
62598
|
+
"""
|
62599
|
+
return self._y_axis_title_font_size
|
62600
|
+
|
62601
|
+
@builtins.property
|
62602
|
+
def y_axis_tick_font_size(self) -> int:
|
62603
|
+
"""
|
62604
|
+
The font size of the y-axis ticks.
|
62605
|
+
"""
|
62606
|
+
return self._y_axis_tick_font_size
|
62607
|
+
|
62608
|
+
|
62609
|
+
themes_api_TimeSeriesChartThemeV1.__name__ = "TimeSeriesChartThemeV1"
|
62610
|
+
themes_api_TimeSeriesChartThemeV1.__qualname__ = "TimeSeriesChartThemeV1"
|
62611
|
+
themes_api_TimeSeriesChartThemeV1.__module__ = "nominal_api.themes_api"
|
62612
|
+
|
62613
|
+
|
62614
|
+
class themes_api_UpdateChartThemeRequest(ConjureBeanType):
|
62615
|
+
|
62616
|
+
@builtins.classmethod
|
62617
|
+
def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
|
62618
|
+
return {
|
62619
|
+
'name': ConjureFieldDefinition('name', str),
|
62620
|
+
'content': ConjureFieldDefinition('content', themes_api_ChartThemeContent)
|
62621
|
+
}
|
62622
|
+
|
62623
|
+
__slots__: List[str] = ['_name', '_content']
|
62624
|
+
|
62625
|
+
def __init__(self, content: "themes_api_ChartThemeContent", name: str) -> None:
|
62626
|
+
self._name = name
|
62627
|
+
self._content = content
|
62628
|
+
|
62629
|
+
@builtins.property
|
62630
|
+
def name(self) -> str:
|
62631
|
+
"""
|
62632
|
+
The name of the theme.
|
62633
|
+
"""
|
62634
|
+
return self._name
|
62635
|
+
|
62636
|
+
@builtins.property
|
62637
|
+
def content(self) -> "themes_api_ChartThemeContent":
|
62638
|
+
"""
|
62639
|
+
The theme fields.
|
62640
|
+
"""
|
62641
|
+
return self._content
|
62642
|
+
|
62643
|
+
|
62644
|
+
themes_api_UpdateChartThemeRequest.__name__ = "UpdateChartThemeRequest"
|
62645
|
+
themes_api_UpdateChartThemeRequest.__qualname__ = "UpdateChartThemeRequest"
|
62646
|
+
themes_api_UpdateChartThemeRequest.__module__ = "nominal_api.themes_api"
|
62647
|
+
|
62648
|
+
|
62649
|
+
class timeseries_archetype_SeriesArchetypeService(Service):
|
62650
|
+
"""
|
62651
|
+
[INTERNAL]
|
62652
|
+
A series archetype represents the constant information about data in a series - specifically, the name, units, a
|
62653
|
+
description, and the tags. Series archetypes can be used to query points from specific series depending on the tag
|
62654
|
+
value selections.
|
62655
|
+
"""
|
62656
|
+
|
62657
|
+
def batch_get(self, auth_header: str, request: "timeseries_archetype_api_BatchGetSeriesArchetypeRequest") -> "timeseries_archetype_api_BatchGetSeriesArchetypeResponse":
|
62658
|
+
"""
|
62659
|
+
Batch get series archetypes by DataSourceRid.
|
62660
|
+
"""
|
62661
|
+
|
62662
|
+
_headers: Dict[str, Any] = {
|
62663
|
+
'Accept': 'application/json',
|
62664
|
+
'Content-Type': 'application/json',
|
62665
|
+
'Authorization': auth_header,
|
62666
|
+
}
|
62667
|
+
|
62668
|
+
_params: Dict[str, Any] = {
|
62669
|
+
}
|
62670
|
+
|
62671
|
+
_path_params: Dict[str, Any] = {
|
62672
|
+
}
|
62673
|
+
|
62674
|
+
_json: Any = ConjureEncoder().default(request)
|
62675
|
+
|
62676
|
+
_path = '/timeseries/archetype/v1/series-archetype/batch-get'
|
62677
|
+
_path = _path.format(**_path_params)
|
62678
|
+
|
62679
|
+
_response: Response = self._request(
|
62680
|
+
'POST',
|
62681
|
+
self._uri + _path,
|
62682
|
+
params=_params,
|
62683
|
+
headers=_headers,
|
62684
|
+
json=_json)
|
62685
|
+
|
62686
|
+
_decoder = ConjureDecoder()
|
62687
|
+
return _decoder.decode(_response.json(), timeseries_archetype_api_BatchGetSeriesArchetypeResponse, self._return_none_for_unknown_union_types)
|
62688
|
+
|
62689
|
+
def create(self, auth_header: str, request: "timeseries_archetype_api_CreateSeriesArchetypeRequest") -> None:
|
62690
|
+
"""
|
62691
|
+
Create a new series archetype.
|
62692
|
+
"""
|
62693
|
+
|
62694
|
+
_headers: Dict[str, Any] = {
|
62695
|
+
'Accept': 'application/json',
|
62696
|
+
'Content-Type': 'application/json',
|
62697
|
+
'Authorization': auth_header,
|
62698
|
+
}
|
62699
|
+
|
62700
|
+
_params: Dict[str, Any] = {
|
62701
|
+
}
|
62702
|
+
|
62703
|
+
_path_params: Dict[str, Any] = {
|
62704
|
+
}
|
62705
|
+
|
62706
|
+
_json: Any = ConjureEncoder().default(request)
|
62707
|
+
|
62708
|
+
_path = '/timeseries/archetype/v1/series-archetype'
|
62709
|
+
_path = _path.format(**_path_params)
|
62710
|
+
|
62711
|
+
_response: Response = self._request(
|
62712
|
+
'POST',
|
62713
|
+
self._uri + _path,
|
62714
|
+
params=_params,
|
62715
|
+
headers=_headers,
|
62716
|
+
json=_json)
|
62717
|
+
|
62718
|
+
return
|
62719
|
+
|
62720
|
+
def batch_create(self, auth_header: str, request: "timeseries_archetype_api_BatchCreateSeriesArchetypeRequest") -> None:
|
62721
|
+
"""
|
62722
|
+
Idempotently creates series archetypes.
|
62723
|
+
"""
|
62724
|
+
|
62725
|
+
_headers: Dict[str, Any] = {
|
62726
|
+
'Accept': 'application/json',
|
62727
|
+
'Content-Type': 'application/json',
|
62728
|
+
'Authorization': auth_header,
|
62729
|
+
}
|
62730
|
+
|
62731
|
+
_params: Dict[str, Any] = {
|
62732
|
+
}
|
62733
|
+
|
62734
|
+
_path_params: Dict[str, Any] = {
|
62735
|
+
}
|
62736
|
+
|
62737
|
+
_json: Any = ConjureEncoder().default(request)
|
62738
|
+
|
62739
|
+
_path = '/timeseries/archetype/v1/series-archetype/batch-create'
|
62740
|
+
_path = _path.format(**_path_params)
|
62741
|
+
|
62742
|
+
_response: Response = self._request(
|
62743
|
+
'POST',
|
62744
|
+
self._uri + _path,
|
62745
|
+
params=_params,
|
62746
|
+
headers=_headers,
|
62747
|
+
json=_json)
|
62748
|
+
|
62749
|
+
return
|
62750
|
+
|
62751
|
+
def get(self, auth_header: str, rid: str) -> "timeseries_archetype_api_SeriesArchetype":
|
62752
|
+
"""
|
62753
|
+
Get a series archetype from its series archetype rid.
|
62754
|
+
"""
|
62755
|
+
|
62756
|
+
_headers: Dict[str, Any] = {
|
62757
|
+
'Accept': 'application/json',
|
62758
|
+
'Authorization': auth_header,
|
62759
|
+
}
|
62760
|
+
|
62761
|
+
_params: Dict[str, Any] = {
|
62762
|
+
}
|
62763
|
+
|
62764
|
+
_path_params: Dict[str, Any] = {
|
62765
|
+
'rid': rid,
|
62766
|
+
}
|
62767
|
+
|
62768
|
+
_json: Any = None
|
62769
|
+
|
62770
|
+
_path = '/timeseries/archetype/v1/series-archetype/{rid}'
|
62771
|
+
_path = _path.format(**_path_params)
|
62772
|
+
|
62773
|
+
_response: Response = self._request(
|
62774
|
+
'GET',
|
62775
|
+
self._uri + _path,
|
62776
|
+
params=_params,
|
62777
|
+
headers=_headers,
|
62778
|
+
json=_json)
|
62779
|
+
|
62780
|
+
_decoder = ConjureDecoder()
|
62781
|
+
return _decoder.decode(_response.json(), timeseries_archetype_api_SeriesArchetype, self._return_none_for_unknown_union_types)
|
62782
|
+
|
62783
|
+
def update_metadata(self, auth_header: str, request: "timeseries_archetype_api_UpdateSeriesArchetypeMetadataRequest", rid: str) -> "timeseries_archetype_api_SeriesArchetype":
|
62784
|
+
"""
|
62785
|
+
Update the metadata on an existing series archetype.
|
62786
|
+
Throws SeriesArchetypeNotFound if the series archetype does not exist.
|
62787
|
+
"""
|
62788
|
+
|
62789
|
+
_headers: Dict[str, Any] = {
|
62790
|
+
'Accept': 'application/json',
|
62791
|
+
'Content-Type': 'application/json',
|
62792
|
+
'Authorization': auth_header,
|
62793
|
+
}
|
62794
|
+
|
62795
|
+
_params: Dict[str, Any] = {
|
62796
|
+
}
|
62797
|
+
|
62798
|
+
_path_params: Dict[str, Any] = {
|
62799
|
+
'rid': rid,
|
62800
|
+
}
|
62801
|
+
|
62802
|
+
_json: Any = ConjureEncoder().default(request)
|
62803
|
+
|
62804
|
+
_path = '/timeseries/archetype/v1/series-archetype/{rid}/metadata'
|
62805
|
+
_path = _path.format(**_path_params)
|
62806
|
+
|
62807
|
+
_response: Response = self._request(
|
62808
|
+
'POST',
|
62809
|
+
self._uri + _path,
|
62810
|
+
params=_params,
|
62811
|
+
headers=_headers,
|
62812
|
+
json=_json)
|
62813
|
+
|
62814
|
+
_decoder = ConjureDecoder()
|
62815
|
+
return _decoder.decode(_response.json(), timeseries_archetype_api_SeriesArchetype, self._return_none_for_unknown_union_types)
|
62816
|
+
|
62817
|
+
|
62818
|
+
timeseries_archetype_SeriesArchetypeService.__name__ = "SeriesArchetypeService"
|
62819
|
+
timeseries_archetype_SeriesArchetypeService.__qualname__ = "SeriesArchetypeService"
|
62820
|
+
timeseries_archetype_SeriesArchetypeService.__module__ = "nominal_api.timeseries_archetype"
|
62821
|
+
|
62822
|
+
|
62823
|
+
class timeseries_archetype_api_BatchCreateSeriesArchetypeRequest(ConjureBeanType):
|
62824
|
+
|
62825
|
+
@builtins.classmethod
|
62826
|
+
def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
|
62827
|
+
return {
|
62828
|
+
'requests': ConjureFieldDefinition('requests', List[timeseries_archetype_api_CreateSeriesArchetypeRequest])
|
62829
|
+
}
|
62830
|
+
|
62831
|
+
__slots__: List[str] = ['_requests']
|
62832
|
+
|
62833
|
+
def __init__(self, requests: List["timeseries_archetype_api_CreateSeriesArchetypeRequest"]) -> None:
|
62834
|
+
self._requests = requests
|
62835
|
+
|
62836
|
+
@builtins.property
|
62837
|
+
def requests(self) -> List["timeseries_archetype_api_CreateSeriesArchetypeRequest"]:
|
62838
|
+
return self._requests
|
62839
|
+
|
62840
|
+
|
62841
|
+
timeseries_archetype_api_BatchCreateSeriesArchetypeRequest.__name__ = "BatchCreateSeriesArchetypeRequest"
|
62019
62842
|
timeseries_archetype_api_BatchCreateSeriesArchetypeRequest.__qualname__ = "BatchCreateSeriesArchetypeRequest"
|
62020
62843
|
timeseries_archetype_api_BatchCreateSeriesArchetypeRequest.__module__ = "nominal_api.timeseries_archetype_api"
|
62021
62844
|
|
@@ -65296,6 +66119,8 @@ datasource_PropertyName = str
|
|
65296
66119
|
|
65297
66120
|
ingest_api_PropertyName = str
|
65298
66121
|
|
66122
|
+
themes_api_ChartThemeRid = str
|
66123
|
+
|
65299
66124
|
scout_datareview_api_DataReviewRid = str
|
65300
66125
|
|
65301
66126
|
scout_rids_api_SnapshotRid = str
|
@@ -65404,6 +66229,8 @@ timeseries_logicalseries_api_MeasurementName = str
|
|
65404
66229
|
|
65405
66230
|
event_EventRid = str
|
65406
66231
|
|
66232
|
+
themes_api_HexColor = str
|
66233
|
+
|
65407
66234
|
scout_compute_representation_api_ComputeExpression = str
|
65408
66235
|
|
65409
66236
|
scout_datasource_connection_api_ColumnName = str
|