-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathDataflows_details.txt
211 lines (203 loc) · 8.68 KB
/
Dataflows_details.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
Python Library Documentation: package simplepbi.dataflows in simplepbi
NAME
simplepbi.dataflows
DESCRIPTION
.
@@@@@@@@@@
@@@@..........@@@@
@@@ . @@@
@@. . . @@
@ . _ . . @
@........| |...................@ *********************************************
@ . | | _____ . @
@ . | | | __ \ . @ La Data Web
@ . | |__| | | |. *** @
@........|____| | | |...* *.@ Copyright © 2022 Ignacio Barrau
@ . . | |__| |. * *@
@ . . |_____/ . * *@ *********************************************
@ . . . * *@
@ . . . *******@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
PACKAGE CONTENTS
CLASSES
builtins.object
Dataflows
class Dataflows(builtins.object)
| Dataflows(token)
|
| Simple library to use the Power BI api and obtain dataflows from it.
|
| Methods defined here:
|
| __init__(self, token)
| Create a simplePBI object to request admin API
| Args:
| token: String
| Bearer Token to use the Power Bi Rest API
|
| cancel_dataflow_transaction_in_group_preview(self, workspace_id, dataflow_id, transaction_id)
| Attempts to Cancel the specified transactions.
| ### Parameters
| ----
| workspace_id: str uuid
| The Power Bi workspace id. You can take it from PBI Service URL
| dataflow_id: str uuid
| The Power Bi dataflow id. You can take it from PBI Service URL
| transaction_id: str uuid
| The transaction id. You can get it from get_dataflow_transaction_in_group
| ### Returns
| ----
| Response object from requests library. 202 OK
|
| delete_dataflow_in_group(self, workspace_id, dataflow_id)
| Deletes the specified dataflow from the specified workspace.
| ### Parameters
| ----
| dataflow_id: str uuid
| The Power Bi dataflow id. You can take it from PBI Service URL
| ### Returns
| ----
| Response object from requests library. 200 OK
|
| get_dataflow_in_group(self, workspace_id, dataflow_id)
| Returns a single dataflow from the specified workspace.
| ### Parameters
| ----
| workspace_id: str uuid
| The Power Bi workspace id. You can take it from PBI Service URL
| dataflow_id: str uuid
| The Power Bi dataflow id. You can take it from PBI Service URL
| ### Returns
| ----
| Dict:
| A dictionary containing a dataflow in the workspace.
|
| get_dataflow_transaction_in_group(self, workspace_id, dataflow_id)
| Returns a list of transactions for the specified dataflow.
| ### Parameters
| ----
| workspace_id: str uuid
| The Power Bi workspace id. You can take it from PBI Service URL
| dataflow_id: str uuid
| The Power Bi dataflow id. You can take it from PBI Service URL
| ### Returns
| ----
| Dict:
| A dictionary containing all the transactions in the dataflow from the workspace.
|
| get_dataflows_in_group(self, workspace_id)
| Returns a list of all dataflows from the specified workspace.
| ### Parameters
| ----
| workspace_id: str uuid
| The Power Bi workspace id. You can take it from PBI Service URL
| ### Returns
| ----
| Dict:
| A dictionary containing all the dataflows in the workspace.
|
| get_datasources_in_group(self, workspace_id, dataflow_id)
| Returns a list of datasources for the specified dataflow.
| ### Parameters
| ----
| workspace_id: str uuid
| The Power Bi workspace id. You can take it from PBI Service URL
| dataflow_id: str uuid
| The Power Bi dataflow id. You can take it from PBI Service URL
| ### Returns
| ----
| Dict:
| A dictionary containing all the datasources in the dataflow from the workspace.
|
| get_upstream_dataflow_in_group(self, workspace_id, dataflow_id)
| Returns a list of upstream dataflows for dataflows from the specified workspace.
| ### Parameters
| ----
| workspace_id: str uuid
| The Power Bi workspace id. You can take it from PBI Service URL
| ### Returns
| ----
| Dict:
| A dictionary containing all upstream dataflows in the dataflow from a workspace
|
| refresh_dataflow_in_group(self, workspace_id, dataflow_id, notifyOption, processType=None)
| Triggers a refresh for the specified dataflow. The only supported mail notification options are either in case of failure, or none. MailOnCompletion is not supported.
|
| ### Parameters
| ----
| workspace_id: str uuid
| The Power Bi workspace id. You can take it from PBI Service URL
| dataflow_id: str uuid
| The Power Bi dataflow id. You can take it from PBI Service URL
| processType: str uuid
| Type of refresh process to use.
| ### Request Body
| ----
| notifyOption: NotifyOption str
| Mail notification options (success and/or failure, or none). Options: { MailOnCompletion, MailOnFailure, NoNotification }
| ### Returns
| ----
| Response object from requests library. 202 OK
|
| update_dataflow_preview(self, workspace_id, dataflow_id, allowNativeQueries=None, computeEngineBehavior=None, description=None, name=None)
| Update dataflow properties, capabilities and settings.
| ### Parameters
| ----
| workspace_id: str uuid
| The Power Bi workspace id. You can take it from PBI Service URL
| dataflow_id: str uuid
| The Power Bi dataflow id. You can take it from PBI Service URL
| ### Request Body
| ----
| allowNativeQueries: bool
| Allow native queries
| computeEngineBehavior: str
| Compute Engine Behavior. Examples: "computeOptimized", "computeOn" or "computeDisabled"
| description: str
| New description for the dataflow
| name: str
| New name for the dataflow
| ### Returns
| ----
| Response object from requests library. 200 OK
| ### Limitations
| ----
| The limit on the number of time slots per day depends on whether a Premium or Shared capacity is used.
|
| update_refresh_schedule_in_group_preview(self, workspace_id, dataflow_id, NotifyOption=None, days=None, enabled=None, localTimeZoneId=None, times=None)
| Creates or updates the specified dataflow refresh schedule configuration.
| ### Parameters
| ----
| workspace_id: str uuid
| The Power Bi workspace id. You can take it from PBI Service URL
| dataflow_id: str uuid
| The Power Bi dataflow id. You can take it from PBI Service URL
| ### Request Body
| ----
| NotifyOption: ShceduleNotifyOption str
| Notification option at scheduled refresh termination. Example MailOnFailure or NoNotification.
| days: str []
| Days to execute the refresh. Example: ["Sunday", "Tuesday"]
| enabled: bool
| is the refresh enabled
| localTimeZoneId: str
| The ID of the timezone to use. See TimeZone Info. Example "UTC"
| times: str []
| Times to execute the refresh within each day. Example: ["07:00", "16:00"]
| ### Returns
| ----
| Response object from requests library. 200 OK
| ### Limitations
| ----
| The limit on the number of time slots per day depends on whether a Premium or Shared capacity is used.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables (if defined)
|
| __weakref__
| list of weak references to the object (if defined)
FILE
c:\users\ibarrau\documents\github\simplepbi\simplepbi\dataflows\__init__.py