API Docs for:
Show:

PyJujuAPI Class

Defined in: app/store/env/sandbox.js:223
Module: env.sandbox
Parent Module: env

A sandbox Juju environment using the Python API.

Methods

close

() Undefined

Defined in app/store/env/sandbox.js:334

Closes the connection to the sandbox Juju environment. Called by ClientConnection.

Returns:

Undefined: Nothing.

destructor

() Undefined

Defined in app/store/env/sandbox.js:350

Do any extra work to destroy the object.

Returns:

Undefined: Nothing.

initializer

() Undefined

Defined in app/store/env/sandbox.js:241

Initializes.

Returns:

Undefined: Nothing.

open

(
  • client
)
Undefined

Defined in app/store/env/sandbox.js:252

Opens the connection to the sandbox Juju environment. Called by ClientConnection, which sends itself.

Parameters:

  • client Object

    A ClientConnection.

Returns:

Undefined: Nothing.

performOp_add_relation

(
  • data
)

Defined in app/store/env/sandbox.js:558

Handles adding a relation between two supplied services from the client

Parameters:

  • data Object

    Object contains the operation, two endpoint strings and request id.

performOp_add_unit

(
  • data
)

Defined in app/store/env/sandbox.js:419

Handles add unit operations from the client.

Parameters:

  • data Object

    Contains servicename and numunits required for adding additional units.

performOp_deploy

(
  • data
)
Undefined

Defined in app/store/env/sandbox.js:392

Handles deploy operations from client. Called by receive. client.receive will receive all sent values back, transparently. If there is an error, the reply will also have an "err" with a string describing the error.

Parameters:

  • data Object

    A hash minimally of charmurl, and optionally also servicename, config, configraw, and numunits.

Returns:

Undefined: Nothing.

performOp_destroy_service

(
  • data
)

Defined in app/store/env/sandbox.js:449

destroy_service from the client.

Parameters:

  • data Object

    contains service_name.

performOp_expose

(
  • data
)

Defined in app/store/env/sandbox.js:528

Handles exposing a service request from the client.

Parameters:

  • data Object

    Contains service_name to expose and a callback.

performOp_get_charm

(
  • data
)

Defined in app/store/env/sandbox.js:459

get_charm from the client.

Parameters:

  • data Object

    contains service_name.

performOp_get_service

(
  • data
)

Defined in app/store/env/sandbox.js:439

get_service from the client.

Parameters:

  • data Object

    contains service_name.

performOp_login

(
  • data
)
Undefined

Defined in app/store/env/sandbox.js:377

Handles login operations from the client. Called by "receive". client.receive will receive all sent values back, transparently, plus a "result" value that will be true or false, representing whether the authentication succeeded or failed.

Parameters:

  • data Object

    A hash minimally of user and password.

Returns:

Undefined: Nothing.

performOp_remove_relation

(
  • data
)

Defined in app/store/env/sandbox.js:599

Handles removing a relation between two supplied services from the client

Parameters:

  • data Object

    Object contains the operation, two endpoint strings and request id.

performOp_remove_unit

(
  • data
)

Defined in app/store/env/sandbox.js:510

Handles the remove unit operations from the client

Parameters:

  • data Object

    Contains unit_names to remove and a calback.

performOp_resolved

(
  • data
)

Defined in app/store/env/sandbox.js:501

Perform 'resolved' operation.

Parameters:

  • data Object

    with unitName and optional relation name.

performOp_set_config

(
  • data
)

Defined in app/store/env/sandbox.js:480

set_config from the client.

Parameters:

  • data Object

    contains service_name and a config mapping of key/value pairs.

performOp_set_constraints

(
  • data
)

Defined in app/store/env/sandbox.js:469

set_constraints from the client.

Parameters:

  • data Object

    contains service_name and constraints as either a key/value map or an array of "key=value" strings..

performOp_unexpose

(
  • data
)

Defined in app/store/env/sandbox.js:543

Handles unexposing a service request from the client.

Parameters:

  • data Object

    contains service_name to unexpose and a callback.

performOp_update_annotations

(
  • data
)

Defined in app/store/env/sandbox.js:491

Update annotations rpc

Parameters:

  • data Object

    with entity name and payload.

receive

(
  • data
)
Undefined

Defined in app/store/env/sandbox.js:360

Receives messages from the client and dispatches them.

Parameters:

  • data Object

    A hash of data sent from the client.

Returns:

Undefined: Nothing.

sendDelta

() Undefined

Defined in app/store/env/sandbox.js:288

Send a delta of events to the client from since the last time they asked.

Returns:

Undefined: Nothing.