service
Service Builder 🏗️
Builder for the service
section of a systemd service file.
ServiceBuilder
Bases: _Builder
Builder for the service
section of a systemd service file.
Source code in systemd_py/builders/service.py
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 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 |
|
allowed_none_fields: List[str]
property
Returns a list of fields that are allowed to be None
Returns:
Type | Description |
---|---|
List[str]
|
List of fields that are allowed to be None |
build()
Builds the service
section of a systemd service file.
Returns:
Type | Description |
---|---|
Service
|
The |
Source code in systemd_py/builders/service.py
with_bus_name(bus_name)
Sets the bus_name
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
bus_name |
str
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_exec_reload(exec_reload)
Sets the exec_reload
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
exec_reload |
List[str]
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_exec_start(exec_start)
Sets the exec_start
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
exec_start |
List[str]
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_exec_start_post(exec_start_post)
Sets the exec_start_post
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
exec_start_post |
List[str]
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_exec_start_pre(exec_start_pre)
Sets the exec_start_pre
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
exec_start_pre |
List[str]
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_exec_stop(exec_stop)
Sets the exec_stop
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
exec_stop |
List[str]
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_exec_stop_post(exec_stop_post)
Sets the exec_stop_post
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
exec_stop_post |
List[str]
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_group(group)
Sets the group
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
group |
str
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_nice(nice)
Sets the nice
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
nice |
int
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_notify_access(notify_access)
Sets the notify_access
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
notify_access |
str
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_pid_file(pid_file)
Sets the pid_file
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pid_file |
str
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_remain_after_exit(remain_after_exit)
Sets the remain_after_exit
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
remain_after_exit |
bool
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_restart(restart)
Sets the restart
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
restart |
RestartType
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_restart_sec(restart_sec)
Sets the restart_sec
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
restart_sec |
int
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_timeout_sec(timeout_sec)
Sets the timeout_sec
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
timeout_sec |
int
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_type(type)
Sets the type
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
type |
TypeType
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |
Source code in systemd_py/builders/service.py
with_user(user)
Sets the user
field of the service
section of a systemd service file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user |
str
|
The |
required |
Returns:
Type | Description |
---|---|
ServiceBuilder
|
The |