ivcap_client.order

Module Contents

Classes

Order	This class represents a particular order placed
OrderIter	Helper class that provides a standard way to create an ABC using
OrderParameter

class ivcap_client.order.Order(ivcap: ivcap_client.ivcap.IVCAP, **kwargs)

This class represents a particular order placed at a particular IVCAP deployment

property urn: str

property parameters: Dict[str, ivcap_client.models.parameter_t.ParameterT]

id: str

name: Optional[str]

service: Optional[ivcap_client.ivcap.URN]

ordered_at: Optional[datetime.datetime.datetime]

started_at: Optional[datetime.datetime.datetime]

finished_at: Optional[datetime.datetime.datetime]

policy: Optional[ivcap_client.ivcap.URN]

account: Optional[ivcap_client.ivcap.URN]

classmethod _from_list_item(item: ivcap_client.models.order_list_item.OrderListItem, ivcap: ivcap_client.ivcap.IVCAP)

__update__(**kwargs)

status(refresh=True) → ivcap_client.models.order_status_rt.OrderStatusRT

metadata() → List[ivcap_client.aspect.Aspect]

add_metadata(aspect: Dict[str, any], schema: Optional[str] = None) → Order

Add a metadata ‘aspect’ to this order. The ‘schema’ of the aspect, if not defined is expected to found in the ‘aspect’ under the ‘$schema’ key.

Parameters:

• aspect (dict) – The aspect to be attached

• schema (Optional[str], optional) – Schema of the aspect. Defaults to ‘aspect[“$schema”]’.

Returns:

The metadata record created

Return type:

metadata

refresh() → Order

__repr__()

Return repr(self).

class ivcap_client.order.OrderIter(ivcap: ivcap_client.ivcap.IVCAP, **kwargs)

Bases: ivcap_client.utils.BaseIter[Order, ivcap_client.models.order_list_item.OrderListItem]

Helper class that provides a standard way to create an ABC using inheritance.

_next_el(el) → Order

_get_list() → List[ivcap_client.models.order_list_item.OrderListItem]

class ivcap_client.order.OrderParameter(p: ivcap_client.models.parameter_t.ParameterT)

name: str

value: any