bitmovin_api_sdk.encoding.live.standby_pools package
Subpackages
Submodules
bitmovin_api_sdk.encoding.live.standby_pools.standby_pools_api module
- class bitmovin_api_sdk.encoding.live.standby_pools.standby_pools_api.StandbyPoolsApi(**kwargs)[source]
Bases:
BaseApi- create(live_standby_pool_request: LiveStandbyPoolRequest, **kwargs: dict) LiveStandbyPoolDetails[source]
Create new standby pool
- Parameters
live_standby_pool_request (LiveStandbyPoolRequest, required) – The pool to be created
- Returns
- Return type
- delete(pool_id: string_types, **kwargs: dict) BitmovinResponse[source]
Delete standby pool by id
- Parameters
pool_id (string_types, required) – Id of the standby pool
- Returns
Id of the standby pool that was deleted
- Return type
- get(pool_id: string_types, **kwargs: dict) LiveStandbyPoolDetails[source]
Get details of a standby pool by id
- Parameters
pool_id (string_types, required) – Id of the standby pool
- Returns
- Return type
- list(**kwargs: dict) LiveStandbyPoolResponse[source]
List Standby pools
- Returns
Standby pools list response
- Return type
- patch(pool_id: string_types, live_standby_pool_update: LiveStandbyPoolUpdate, **kwargs: dict) LiveStandbyPoolDetails[source]
Partially update standby pool by id
- Parameters
pool_id (string_types, required) – Id of the standby pool
live_standby_pool_update (LiveStandbyPoolUpdate, required) – The updated standby pool object.
- Returns
- Return type