Skip to main content

vantage_sdk.workbench.user_service

SDK helpers for cluster-scoped user service operations.

Classes​

UserServiceSDK()​

SDK for cluster-scoped user service operations.

Methods​

  • create(self, ctx, *, cluster_name: 'str', workload: 'str', name: 'str | None' = None, configuration_preset: 'str | None' = None, image: 'str | None' = None, resolution: 'str | None' = None) -> 'ClusterServiceResponse': Create a user service from a configuration preset.
  • delete(self, ctx, *, cluster_name: 'str', workload: 'str', service_id: 'str') -> 'ClusterServiceResponse': Delete a user service by workload and id (idempotent server-side).
  • get(self, ctx, *, cluster_name: 'str', workload: 'str', service_id: 'str') -> 'ClusterServiceResponse': Get a user service by workload and id.
  • list(self, ctx, *, cluster_name: 'str', workload: 'str | None' = None, username: 'str | None' = None) -> 'ClusterServiceResponse': List user services, optionally filtered by workload and username.
  • normalize_service_type(workload: 'str') -> 'str': Lowercase and validate a workload name against USER_SERVICES.
  • normalize_workload(workload: 'str') -> 'str': Lowercase and validate a workload name against USER_SERVICES.