PlacementGroupsClient
- class PlacementGroupsClient(client: Client)[source]
- create(name: str, type: str, labels: dict[str, str] | None = None) CreatePlacementGroupResponse [source]
Creates a new Placement Group.
- Parameters:
name – str Placement Group Name
type – str Type of the Placement Group
labels – Dict[str, str] (optional) User-defined labels (key-value pairs)
- Returns:
- delete(placement_group: PlacementGroup | BoundPlacementGroup) bool [source]
Deletes a Placement Group.
- Parameters:
placement_group –
BoundPlacementGroup
orPlacementGroup
- Returns:
boolean
- get_all(label_selector: str | None = None, name: str | None = None, sort: list[str] | None = None) list[BoundPlacementGroup] [source]
Get all Placement Groups
- Parameters:
label_selector – str (optional) Can be used to filter Placement Groups by labels. The response will only contain Placement Groups matching the label selector values.
name – str (optional) Can be used to filter Placement Groups by their name.
sort – List[str] (optional) Choices: id name created (You can add one of “:asc”, “:desc” to modify sort order. ( “:asc” is default))
- Returns:
List[
BoundPlacementGroup
]
- get_by_id(id: int) BoundPlacementGroup [source]
Returns a specific Placement Group object
- Parameters:
id – int
- Returns:
- get_by_name(name: str) BoundPlacementGroup | None [source]
Get Placement Group by name
- Parameters:
name – str Used to get Placement Group by name
- Returns:
class:BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>
- get_list(label_selector: str | None = None, page: int | None = None, per_page: int | None = None, name: str | None = None, sort: list[str] | None = None, type: str | None = None) PlacementGroupsPageResult [source]
Get a list of Placement Groups
- Parameters:
label_selector – str (optional) Can be used to filter Placement Groups by labels. The response will only contain Placement Groups matching the label selector values.
page – int (optional) Specifies the page to fetch
per_page – int (optional) Specifies how many results are returned by page
name – str (optional) Can be used to filter Placement Groups by their name.
sort – List[str] (optional) Choices: id name created (You can add one of “:asc”, “:desc” to modify sort order. ( “:asc” is default))
- Returns:
(List[
BoundPlacementGroup
],Meta
)
- update(placement_group: PlacementGroup | BoundPlacementGroup, labels: dict[str, str] | None = None, name: str | None = None) BoundPlacementGroup [source]
Updates the description or labels of a Placement Group.
- Parameters:
placement_group –
BoundPlacementGroup
orPlacementGroup
labels – Dict[str, str] (optional) User-defined labels (key-value pairs)
name – str (optional) New name to set
- Returns:
- class BoundPlacementGroup(client: ClientEntityBase, data: dict, complete: bool = True)[source]
-
- model
alias of
PlacementGroup
- update(labels: dict[str, str] | None = None, name: str | None = None) BoundPlacementGroup [source]
Updates the name or labels of a Placement Group
- Parameters:
labels – Dict[str, str] (optional) User-defined labels (key-value pairs)
name – str, (optional) New Name to set
- Returns:
- class PlacementGroup(id: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, servers: list[int] | None = None, type: str | None = None, created: str | None = None)[source]
Placement Group Domain
- Parameters:
id – int ID of the Placement Group
name – str Name of the Placement Group
labels – dict User-defined labels (key-value pairs)
servers – List[ int ] List of server IDs assigned to the Placement Group
type – str Type of the Placement Group
created – datetime Point in time when the image was created
- class CreatePlacementGroupResponse(placement_group: BoundPlacementGroup, action: BoundAction | None)[source]
Create Placement Group Response Domain
- Parameters:
placement_group –
BoundPlacementGroup
The Placement Group which was createdaction –
BoundAction
The Action which shows the progress of the Placement Group Creation