kaskada.api.remote_session

Package Contents

Classes

Builder	Helper class that provides a standard way to create an ABC using
Session
RemoteBuilder	The RemoteBuilder is a utility class designed to assist in creating remote sessions to the Kaskada Manager service.

class Builder(endpoint=None, is_secure=None, name=None, client_id=None)

Bases: abc.ABC

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

Parameters:

• endpoint (Optional[str]) –

• is_secure (Optional[bool]) –

• name (Optional[str]) –

• client_id (Optional[str]) –

endpoint(endpoint, is_secure)

Parameters:

• endpoint (str) –

• is_secure (bool) –

name(name)

Parameters:

name (str) –

client_id(client_id)

Parameters:

client_id (str) –

class Session(endpoint, is_secure, client_id=None, client_factory=None)

Parameters:

• endpoint (str) –

• is_secure (bool) –

• client_id (Optional[str]) –

• client_factory (Optional[kaskada.client.ClientFactory]) –

stop()

connect(should_check_health=True)

Parameters:

should_check_health (bool) –

Return type:

kaskada.client.Client

class RemoteBuilder(endpoint, is_secure)

Bases: kaskada.api.session.Builder

The RemoteBuilder is a utility class designed to assist in creating remote sessions to the Kaskada Manager service.

Parameters:

• Builder (kaskada.api.session.Builder) – The Kaskada root builder

• endpoint (str) –

• is_secure (bool) –

build()

Instantiates a Session from the RemoteBuilder instance.

Returns:

A Session object

Return type:

Session