Skip to content

Commit 8b61a2f

Browse files
author
ddraganov
committed
Added type hints for the VSLM namespace
1 parent 6a81c68 commit 8b61a2f

File tree

5 files changed

+555
-0
lines changed

5 files changed

+555
-0
lines changed

pyVmomi/vslm/__init__.pyi

Lines changed: 265 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,265 @@
1+
from typing import List, Literal
2+
from enum import Enum
3+
from pyVmomi import vim, vmodl, vslm
4+
from datetime import datetime
5+
from pyVmomi.VmomiSupport import ManagedMethod, ManagedObject, NoneType
6+
from . import auth as auth
7+
from . import event as event
8+
from . import fault as fault
9+
from . import vso as vso
10+
11+
12+
class ServiceInstance(ManagedObject):
13+
@property
14+
def content(self) -> ServiceInstanceContent: ...
15+
def RetrieveContent(self) -> ServiceInstanceContent: ...
16+
17+
18+
class StorageLifecycleManager(ManagedObject):
19+
def SyncDatastore(self, datastoreUrl: str, fullSync: bool, fcdId: vim.vslm.ID) -> NoneType: ...
20+
def QueryDatastoreInfo(self, datastoreUrl: str) -> List[QueryDatastoreInfoResult]: ...
21+
22+
23+
class Task(ManagedObject):
24+
def QueryResult(self) -> object: ...
25+
def QueryInfo(self) -> TaskInfo: ...
26+
def Cancel(self) -> NoneType: ...
27+
28+
29+
class AboutInfo(vmodl.DynamicData):
30+
@property
31+
def name(self) -> str: ...
32+
@name.setter
33+
def name(self, value: str):
34+
self._name = value
35+
@property
36+
def fullName(self) -> str: ...
37+
@fullName.setter
38+
def fullName(self, value: str):
39+
self._fullName = value
40+
@property
41+
def vendor(self) -> str: ...
42+
@vendor.setter
43+
def vendor(self, value: str):
44+
self._vendor = value
45+
@property
46+
def apiVersion(self) -> str: ...
47+
@apiVersion.setter
48+
def apiVersion(self, value: str):
49+
self._apiVersion = value
50+
@property
51+
def instanceUuid(self) -> str: ...
52+
@instanceUuid.setter
53+
def instanceUuid(self, value: str):
54+
self._instanceUuid = value
55+
56+
57+
class QueryDatastoreInfoResult(vmodl.DynamicData):
58+
@property
59+
def datacenter(self) -> vim.Datacenter: ...
60+
@datacenter.setter
61+
def datacenter(self, value: vim.Datacenter):
62+
self._datacenter = value
63+
@property
64+
def datastore(self) -> vim.Datastore: ...
65+
@datastore.setter
66+
def datastore(self, value: vim.Datastore):
67+
self._datastore = value
68+
69+
70+
class ServiceInstanceContent(vmodl.DynamicData):
71+
@property
72+
def aboutInfo(self) -> AboutInfo: ...
73+
@aboutInfo.setter
74+
def aboutInfo(self, value: AboutInfo):
75+
self._aboutInfo = value
76+
@property
77+
def sessionManager(self) -> vslm.auth.SessionManager: ...
78+
@sessionManager.setter
79+
def sessionManager(self, value: vslm.auth.SessionManager):
80+
self._sessionManager = value
81+
@property
82+
def vStorageObjectManager(self) -> vslm.vso.VStorageObjectManager: ...
83+
@vStorageObjectManager.setter
84+
def vStorageObjectManager(self, value: vslm.vso.VStorageObjectManager):
85+
self._vStorageObjectManager = value
86+
@property
87+
def storageLifecycleManager(self) -> StorageLifecycleManager: ...
88+
@storageLifecycleManager.setter
89+
def storageLifecycleManager(self, value: StorageLifecycleManager):
90+
self._storageLifecycleManager = value
91+
92+
93+
class TaskInfo(vmodl.DynamicData):
94+
@property
95+
def key(self) -> str: ...
96+
@key.setter
97+
def key(self, value: str):
98+
self._key = value
99+
@property
100+
def task(self) -> Task: ...
101+
@task.setter
102+
def task(self, value: Task):
103+
self._task = value
104+
@property
105+
def description(self) -> vmodl.LocalizableMessage: ...
106+
@description.setter
107+
def description(self, value: vmodl.LocalizableMessage):
108+
self._description = value
109+
@property
110+
def name(self) -> ManagedMethod: ...
111+
@name.setter
112+
def name(self, value: ManagedMethod):
113+
self._name = value
114+
@property
115+
def descriptionId(self) -> str: ...
116+
@descriptionId.setter
117+
def descriptionId(self, value: str):
118+
self._descriptionId = value
119+
@property
120+
def entity(self) -> vim.ManagedEntity: ...
121+
@entity.setter
122+
def entity(self, value: vim.ManagedEntity):
123+
self._entity = value
124+
@property
125+
def entityName(self) -> str: ...
126+
@entityName.setter
127+
def entityName(self, value: str):
128+
self._entityName = value
129+
@property
130+
def locked(self) -> List[vim.ManagedEntity]: ...
131+
@locked.setter
132+
def locked(self, value: List[vim.ManagedEntity]):
133+
self._locked = value
134+
@property
135+
def state(self) -> TaskInfo.State | Literal['queued', 'running', 'success', 'error']: ...
136+
@state.setter
137+
def state(self, value: TaskInfo.State | Literal['queued', 'running', 'success', 'error']):
138+
self._state = value
139+
@property
140+
def cancelled(self) -> bool: ...
141+
@cancelled.setter
142+
def cancelled(self, value: bool):
143+
self._cancelled = value
144+
@property
145+
def cancelable(self) -> bool: ...
146+
@cancelable.setter
147+
def cancelable(self, value: bool):
148+
self._cancelable = value
149+
@property
150+
def error(self) -> vmodl.MethodFault: ...
151+
@error.setter
152+
def error(self, value: vmodl.MethodFault):
153+
self._error = value
154+
@property
155+
def result(self) -> object: ...
156+
@result.setter
157+
def result(self, value: object):
158+
self._result = value
159+
@property
160+
def progress(self) -> int: ...
161+
@progress.setter
162+
def progress(self, value: int):
163+
self._progress = value
164+
@property
165+
def reason(self) -> TaskReason: ...
166+
@reason.setter
167+
def reason(self, value: TaskReason):
168+
self._reason = value
169+
@property
170+
def queueTime(self) -> datetime: ...
171+
@queueTime.setter
172+
def queueTime(self, value: datetime):
173+
self._queueTime = value
174+
@property
175+
def startTime(self) -> datetime: ...
176+
@startTime.setter
177+
def startTime(self, value: datetime):
178+
self._startTime = value
179+
@property
180+
def completeTime(self) -> datetime: ...
181+
@completeTime.setter
182+
def completeTime(self, value: datetime):
183+
self._completeTime = value
184+
@property
185+
def eventChainId(self) -> int: ...
186+
@eventChainId.setter
187+
def eventChainId(self, value: int):
188+
self._eventChainId = value
189+
@property
190+
def changeTag(self) -> str: ...
191+
@changeTag.setter
192+
def changeTag(self, value: str):
193+
self._changeTag = value
194+
@property
195+
def parentTaskKey(self) -> str: ...
196+
@parentTaskKey.setter
197+
def parentTaskKey(self, value: str):
198+
self._parentTaskKey = value
199+
@property
200+
def rootTaskKey(self) -> str: ...
201+
@rootTaskKey.setter
202+
def rootTaskKey(self, value: str):
203+
self._rootTaskKey = value
204+
@property
205+
def activationId(self) -> str: ...
206+
@activationId.setter
207+
def activationId(self, value: str):
208+
self._activationId = value
209+
210+
211+
class State(Enum):
212+
queued = "queued"
213+
running = "running"
214+
success = "success"
215+
error = "error"
216+
217+
218+
class TaskReason(vmodl.DynamicData): ...
219+
220+
221+
class TaskReasonAlarm(TaskReason):
222+
@property
223+
def alarmName(self) -> str: ...
224+
@alarmName.setter
225+
def alarmName(self, value: str):
226+
self._alarmName = value
227+
@property
228+
def alarm(self) -> vim.alarm.Alarm: ...
229+
@alarm.setter
230+
def alarm(self, value: vim.alarm.Alarm):
231+
self._alarm = value
232+
@property
233+
def entityName(self) -> str: ...
234+
@entityName.setter
235+
def entityName(self, value: str):
236+
self._entityName = value
237+
@property
238+
def entity(self) -> vim.ManagedEntity: ...
239+
@entity.setter
240+
def entity(self, value: vim.ManagedEntity):
241+
self._entity = value
242+
243+
244+
class TaskReasonSchedule(TaskReason):
245+
@property
246+
def name(self) -> str: ...
247+
@name.setter
248+
def name(self, value: str):
249+
self._name = value
250+
@property
251+
def scheduledTask(self) -> vim.scheduler.ScheduledTask: ...
252+
@scheduledTask.setter
253+
def scheduledTask(self, value: vim.scheduler.ScheduledTask):
254+
self._scheduledTask = value
255+
256+
257+
class TaskReasonSystem(TaskReason): ...
258+
259+
260+
class TaskReasonUser(TaskReason):
261+
@property
262+
def userName(self) -> str: ...
263+
@userName.setter
264+
def userName(self, value: str):
265+
self._userName = value

pyVmomi/vslm/auth/__init__.pyi

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
from pyVmomi.VmomiSupport import ManagedObject, NoneType
2+
3+
4+
class SessionManager(ManagedObject):
5+
def LoginByToken(self, delegatedTokenXml: str) -> NoneType: ...
6+
def Logout(self) -> NoneType: ...

pyVmomi/vslm/event/__init__.pyi

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
from enum import Enum
2+
3+
4+
class VslmEvent():
5+
6+
7+
class VslmEventType(Enum):
8+
preFcdMigrateEvent = "preFcdMigrateEvent"
9+
postFcdMigrateEvent = "postFcdMigrateEvent"
10+
11+
12+
class VslmEventInfo():
13+
14+
15+
class State(Enum):
16+
success = "success"
17+
error = "error"

pyVmomi/vslm/fault/__init__.pyi

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
from pyVmomi import vim, vmodl, vslm
2+
3+
4+
class SyncFault(VslmFault):
5+
@property
6+
def id(self) -> vim.vslm.ID: ...
7+
@id.setter
8+
def id(self, value: vim.vslm.ID):
9+
self._id = value
10+
11+
12+
class VslmFault(vmodl.MethodFault):
13+
@property
14+
def msg(self) -> str: ...
15+
@msg.setter
16+
def msg(self, value: str):
17+
self._msg = value

0 commit comments

Comments
 (0)