otupy.profiles.ctxd.data.web_service.WebService

class WebService(description=None, server=None, port=None, endpoint=None, owner=None)

Bases: Record

it is the description of the service - WebService

Methods

fromdict

Builds instance from dictionary

todict

Converts to dictionary

validate_fields

Attributes

description

Generic description of the web service

endpoint

The endpoint used to connect to the web service

owner

Owner of the web service

port

The port used to connect to the web service

server

Hostname or IP address of the server

__init__(description=None, server=None, port=None, endpoint=None, owner=None)
description: str = None

Generic description of the web service

endpoint: str = None

The endpoint used to connect to the web service

classmethod fromdict(dic, e)

Builds instance from dictionary

It is used during deserialization to create an otupy instance from the text message. It takes an Encoder instance that is used to recursively build instances of the inner objects (the Encoder provides standard methods to create instances of base objects like strings, integers, boolean).

Parameters:
  • dic – The intermediary dictionary representation from which the object is built.

  • e – The Encoder that is being used.

Returns:

An instance of this class initialized from the dictionary values.

owner: str = None

Owner of the web service

port: int = None

The port used to connect to the web service

server: Server = None

Hostname or IP address of the server

todict(e)

Converts to dictionary

It is used to convert this object to an intermediary representation during serialization. It takes an Encoder argument that is used to recursively serialize inner data and structures (the Encoder provides standard methods for converting base types to dictionaries)..

Parameters:

e – The Encoder that is being used.

Returns:

A dictionary compliants to the Language Specification’s serialization rules.