ivcap_client.service

Module Contents

Classes

Service

This clas represents a particular service available

ServiceIter

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

PType

Generic enumeration.

ServiceParameter

POption

Attributes

_verifier

class ivcap_client.service.Service(ivcap: ivcap_client.ivcap.IVCAP, **kwargs)[source]

This clas represents a particular service available in a particular IVCAP deployment

property parameters: Dict[str, ServiceParameter]
property mandatory_parameters: Set[str]
id: Optional[ivcap_client.ivcap.URN]
name: Optional[str]
description: Optional[str]
banner: Optional[str]
policy: Optional[ivcap_client.ivcap.URN]
published_at: Optional[datetime.datetime]
policy: Optional[ivcap_client.ivcap.URN]
account: Optional[ivcap_client.ivcap.URN]
classmethod _from_list_item(item: ivcap_client.models.service_list_item.ServiceListItem, ivcap: ivcap_client.ivcap.IVCAP)[source]
__update__(**kwargs)[source]
status(refresh=True) → ivcap_client.models.service_status_rt_status.ServiceStatusRTStatus[source]
place_order(**kwargs) → ivcap_client.order.Order[source]
refresh() → Service[source]
__repr__()[source]

Return repr(self).

class ivcap_client.service.ServiceIter(ivcap: ivcap_client.ivcap.IVCAP, **kwargs)[source]

Bases: ivcap_client.utils.BaseIter[Service, ivcap_client.models.service_list_item.ServiceListItem]

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

_next_el(el) → Service[source]
_get_list() → List[ivcap_client.models.service_list_item.ServiceListItem][source]
class ivcap_client.service.PType[source]

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

STRING = 'string'
INT = 'int'
FLOAT = 'float'
BOOL = 'bool'
OPTION = 'option'
ARTIFACT = 'artifact'
COLLECTION = 'collection'
ivcap_client.service._verifier
class ivcap_client.service.ServiceParameter(p: ivcap_client.models.parameter_def_t.ParameterDefT)[source]
name: str
type: PType
description: str
label: Optional[str]
unit: Optional[str]
is_constant: Optional[bool] = False
is_unary: Optional[bool] = False
is_optional: Optional[bool] = False
default: Optional[str]
options: Optional[List[ivcap_client.models.parameter_opt_t.ParameterOptT]]
verify(value: Any)[source]

Verify if value is within the constraints and types defined for this parameter

_verify_option(value: Any) → bool[source]
_verify_artifact(v: Any) → bool[source]
_verify_collection(v: Any) → bool[source]
__repr__()[source]

Return repr(self).

class ivcap_client.service.POption(p: ivcap_client.models.parameter_opt_t.ParameterOptT)[source]
value: str
description: Optional[str]
__repr__()[source]

Return repr(self).