yellowdog_client.usage – Usage

All functionality is accessed via the yellowdog_client.usage.AllowancesClient.

class yellowdog_client.usage.AllowancesClient
abstractmethod add_allowance(allowance)
Parameters:

allowance (Allowance)

Return type:

Allowance

abstractmethod boost_allowance(allowance, boost_hours)
Parameters:
Return type:

Allowance

abstractmethod boost_allowance_by_id(allowance_id, boost_hours)
Parameters:

  • allowance_id (str)

  • boost_hours (int)

Return type:

Allowance

abstractmethod check_compute_requirement_exhaustion(compute_requirement)
Parameters:

compute_requirement (ComputeRequirement)

Return type:

List[AllowanceExhaustedNotification]

abstractmethod delete_allowance(allowance)
Parameters:

allowance (Allowance)

Return type:

None

abstractmethod delete_allowance_by_id(allowance_id)
Parameters:

allowance_id (str)

Return type:

None

abstractmethod get_allowance(allowance)
Parameters:

allowance (Allowance)

Return type:

Allowance

abstractmethod get_allowance_by_id(allowance_id)
Parameters:

allowance_id (str)

Return type:

Allowance

abstractmethod get_allowances(allowance_search)
Parameters:

allowance_search (AllowanceSearch)

Return type:

SearchClient[Allowance]

class yellowdog_client.usage.AllowancesClientImpl(service_proxy)
Parameters:

service_proxy (AllowancesServiceProxy)

add_allowance(allowance)
Parameters:

allowance (Allowance)

Return type:

Allowance

boost_allowance(allowance, boost_hours)
Parameters:
Return type:

Allowance

boost_allowance_by_id(allowance_id, boost_hours)
Parameters:

  • allowance_id (str)

  • boost_hours (int)

Return type:

Allowance

check_compute_requirement_exhaustion(compute_requirement)
Parameters:

compute_requirement (ComputeRequirement)

Return type:

List[AllowanceExhaustedNotification]

close()
delete_allowance(allowance)
Parameters:

allowance (Allowance)

Return type:

None

delete_allowance_by_id(allowance_id)
Parameters:

allowance_id (str)

Return type:

None

get_allowance(allowance)
Parameters:

allowance (Allowance)

Return type:

Allowance

get_allowance_by_id(allowance_id)
Parameters:

allowance_id (str)

Return type:

Allowance

get_allowances(search)
Parameters:

search (AllowanceSearch)

Return type:

SearchClient[Allowance]

class yellowdog_client.usage.AllowancesServiceProxy(proxy)
Parameters:

proxy (Proxy)

add_allowance(allowance)
Parameters:

allowance (Allowance)

Return type:

Allowance

boost_allowance_by_id(allowance_id, boost_hours)
Parameters:

  • allowance_id (str)

  • boost_hours (int)

Return type:

Allowance

check_compute_requirement_exhaustion(compute_requirement)
Parameters:

compute_requirement (ComputeRequirement)

Return type:

List[AllowanceExhaustedNotification]

delete_allowance_by_id(allowance_id)
Parameters:

allowance_id (str)

Return type:

None

get_allowance_by_id(allowance_id)
Parameters:

allowance_id (str)

Return type:

Allowance

search_allowances(search, slice_reference)
Parameters: