Internal APIs

These packages are for internal use in communicating with the low-level API. You should use the object oriented API instead. They are documented here for developer reference.

juju.client.client module

Replace auto-generated classes with our own, where necessary.

juju.client._definitions module

class juju.client._definitions.AccessInfo(role=None, scope_tag=None, target_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Action(execution_group=None, name=None, parallel=None, parameters=None, receiver=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ActionMessage(message=None, timestamp=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ActionResult(action=None, completed=None, enqueued=None, error=None, log=None, message=None, output=None, started=None, status=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ActionResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ActionSpec(description=None, params=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Actions(actions=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddApplicationOffer(application_description=None, application_name=None, endpoints=None, model_tag=None, offer_name=None, owner_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddApplicationOffers(offers=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddApplicationUnits(application=None, attach_storage=None, num_units=None, placement=None, policy=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddApplicationUnitsResults(units=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddCharmWithOrigin(charm_origin=None, force=None, url=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddCloudArgs(cloud=None, force=None, name=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddMachineParams(addresses=None, base=None, constraints=None, container_type=None, disks=None, hardware_characteristics=None, instance_id=None, jobs=None, nonce=None, parent_id=None, placement=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddMachines(params=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddMachinesResult(error=None, machine=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddMachinesResults(machines=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddPendingResourcesArgsV2(entity=None, charm_origin=None, macaroon=None, resources=None, tag=None, url=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddPendingResourcesResult(errorresult=None, error=None, pending_ids=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddRelation(endpoints=None, via_cidrs=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddRelationResults(endpoints=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddSecretBackendArg(secretbackend=None, backend_type=None, config=None, id_=None, name=None, token_rotate_interval=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddSecretBackendArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddStorageDetails(storage_tags=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddStorageResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddStorageResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddUser(display_name=None, password=None, username=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddUserResult(error=None, secret_key=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddUserResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AddUsers(users=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Address(cidr=None, config_type=None, is_secondary=None, scope=None, space_id=None, space_name=None, type_=None, value=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AllWatcherId(watcher_id=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AllWatcherNextResults(deltas=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AnnotationsGetResult(annotations=None, entity=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AnnotationsGetResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AnnotationsSet(annotations=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationCharmActionsResult(actions=None, application_tag=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationCharmPlacement(application=None, charm_url=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationCharmPlacements(placements=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationCharmRelations(application=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationCharmRelationsResults(charm_relations=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationConfigUnsetArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationConstraint(constraints=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationDeploy(force=None, application=None, attach_storage=None, channel=None, charm_origin=None, charm_url=None, config=None, config_yaml=None, constraints=None, devices=None, endpoint_bindings=None, num_units=None, placement=None, policy=None, resources=None, storage=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationExpose(application=None, exposed_endpoints=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationGet(application=None, branch=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationGetArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationGetConfigResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationGetConstraintsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationGetResults(application=None, application_config=None, base=None, channel=None, charm=None, config=None, constraints=None, endpoint_bindings=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationInfoResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationInfoResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationMergeBindings(application_tag=None, bindings=None, force=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationMergeBindingsArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationMetricCredential(application=None, metrics_credentials=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationMetricCredentials(creds=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationOfferAdminDetails(applicationofferdetails=None, application_description=None, application_name=None, bindings=None, charm_url=None, connections=None, endpoints=None, offer_name=None, offer_url=None, offer_uuid=None, source_model_tag=None, spaces=None, users=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationOfferAdminDetailsV5(applicationofferdetailsv5=None, application_description=None, application_name=None, charm_url=None, connections=None, endpoints=None, offer_name=None, offer_url=None, offer_uuid=None, source_model_tag=None, users=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationOfferDetails(application_description=None, bindings=None, endpoints=None, offer_name=None, offer_url=None, offer_uuid=None, source_model_tag=None, spaces=None, users=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationOfferDetailsV5(application_description=None, endpoints=None, offer_name=None, offer_url=None, offer_uuid=None, source_model_tag=None, users=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationOfferResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationOfferStatus(active_connected_count=None, application_name=None, charm=None, endpoints=None, err=None, offer_name=None, total_connected_count=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationOffersResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationResult(base=None, channel=None, charm=None, constraints=None, endpoint_bindings=None, exposed=None, exposed_endpoints=None, life=None, principal=None, remote=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationSetCharm(application=None, channel=None, charm_origin=None, charm_url=None, config_settings=None, config_settings_yaml=None, endpoint_bindings=None, force=None, force_base=None, force_units=None, generation=None, resource_ids=None, storage_constraints=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationStatus(base=None, can_upgrade_to=None, charm=None, charm_channel=None, charm_profile=None, charm_rev=None, charm_version=None, endpoint_bindings=None, err=None, exposed=None, exposed_endpoints=None, int_=None, life=None, meter_statuses=None, provider_id=None, public_address=None, relations=None, status=None, subordinate_to=None, units=None, workload_version=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationUnexpose(application=None, exposed_endpoints=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationUnset(application=None, branch=None, options=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationsCharmActionsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ApplicationsDeploy(applications=None, **unknown_fields)

Bases: Type

class juju.client._definitions.AuthUserInfo(controller_access=None, credentials=None, display_name=None, identity=None, last_connection=None, model_access=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BackupsCreateArgs(no_download=None, notes=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BackupsMetadataResult(base=None, checksum=None, checksum_format=None, controller_machine_id=None, controller_machine_inst_id=None, controller_uuid=None, filename=None, finished=None, format_version=None, ha_nodes=None, hostname=None, id_=None, machine=None, model=None, notes=None, size=None, started=None, stored=None, version=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Base(channel=None, name=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Block(id_=None, message=None, tag=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BlockResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BlockResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BlockSwitchParams(message=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BoolResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BranchArg(branch=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BranchInfoArgs(branches=None, detailed=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BranchResults(error=None, generations=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BranchStatus(assigned_units=None, created=None, created_by=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BranchTrackArg(branch=None, entities=None, num_units=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BulkImportStorageParams(storage=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BundleChange(args=None, id_=None, method=None, requires=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BundleChangesMapArgs(args=None, id_=None, method=None, requires=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BundleChangesMapArgsResults(changes=None, errors=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BundleChangesParams(bundleurl=None, yaml=None, **unknown_fields)

Bases: Type

class juju.client._definitions.BundleChangesResults(changes=None, errors=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CIDRParams(cidrs=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ChangeModelCredentialParams(credential_tag=None, model_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ChangeModelCredentialsParams(model_credentials=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Charm(actions=None, config=None, lxd_profile=None, manifest=None, meta=None, metrics=None, revision=None, url=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmActionSpec(description=None, params=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmActions(specs=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmBase(architectures=None, channel=None, name=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmContainer(gid=None, mounts=None, resource=None, uid=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmDeployment(min_version=None, mode=None, service=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmDevice(countmax=None, countmin=None, description=None, name=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmLXDProfile(config=None, description=None, devices=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmManifest(bases=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmMeta(assumes_expr=None, categories=None, charm_user=None, containers=None, deployment=None, description=None, devices=None, extra_bindings=None, min_juju_version=None, name=None, payload_classes=None, peers=None, provides=None, requires=None, resources=None, series=None, storage=None, subordinate=None, summary=None, tags=None, terms=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmMetric(description=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmMetrics(metrics=None, plan=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmMount(location=None, storage=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmOption(default=None, description=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmOrigin(architecture=None, base=None, branch=None, hash_=None, id_=None, instance_key=None, revision=None, risk=None, source=None, track=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmOriginResult(charm_origin=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmPayloadClass(name=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmPlan(required=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmRelation(interface=None, limit=None, name=None, optional=None, role=None, scope=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmResource(description=None, fingerprint=None, name=None, origin=None, path=None, revision=None, size=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmResourceMeta(description=None, name=None, path=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmResourceResult(charmresource=None, errorresult=None, description=None, error=None, fingerprint=None, name=None, origin=None, path=None, revision=None, size=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmResourcesResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmStorage(count_max=None, count_min=None, description=None, location=None, minimum_size=None, name=None, properties=None, read_only=None, shared=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmURL(url=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmURLAndOrigin(charm_origin=None, charm_url=None, macaroon=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmURLAndOrigins(entities=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmURLOriginResult(charm_origin=None, error=None, url=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmsList(names=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CharmsListResult(charm_urls=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Cloud(auth_types=None, ca_certificates=None, config=None, endpoint=None, host_cloud_region=None, identity_endpoint=None, is_controller_cloud=None, region_config=None, regions=None, skip_tls_verify=None, storage_endpoint=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudCredential(attrs=None, auth_type=None, redacted=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudCredentialArg(cloud_name=None, credential_name=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudCredentialArgs(credentials=None, include_secrets=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudCredentialResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudCredentialResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudDetails(auth_types=None, endpoint=None, identity_endpoint=None, regions=None, storage_endpoint=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudImageMetadata(arch=None, image_id=None, priority=None, region=None, root_storage_size=None, root_storage_type=None, source=None, stream=None, version=None, virt_type=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudImageMetadataList(metadata=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudInfo(clouddetails=None, users=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudInfoResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudInfoResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudInstanceTypesConstraint(cloud_tag=None, constraints=None, region=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudInstanceTypesConstraints(constraints=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudRegion(endpoint=None, identity_endpoint=None, name=None, storage_endpoint=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudResult(cloud=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudSpec(cacertificates=None, credential=None, endpoint=None, identity_endpoint=None, is_controller_cloud=None, name=None, region=None, skip_tls_verify=None, storage_endpoint=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudSpecResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudSpecResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudUserInfo(access=None, display_name=None, user=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CloudsResult(clouds=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ConfigResult(config=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ConfigSet(application=None, config=None, config_yaml=None, generation=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ConfigSetArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Constraints(count=None, pool=None, size=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ConsumeApplicationArg(applicationofferdetails=None, application_alias=None, application_description=None, bindings=None, endpoints=None, external_controller=None, macaroon=None, offer_name=None, offer_url=None, offer_uuid=None, source_model_tag=None, spaces=None, users=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ConsumeApplicationArgV5(applicationofferdetailsv5=None, application_alias=None, application_description=None, endpoints=None, external_controller=None, macaroon=None, offer_name=None, offer_url=None, offer_uuid=None, source_model_tag=None, users=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ConsumeApplicationArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ConsumeApplicationArgsV5(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ConsumeOfferDetails(external_controller=None, macaroon=None, offer=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ConsumeOfferDetailsArg(offer_urls=None, user_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ConsumeOfferDetailsResult(consumeofferdetails=None, error=None, external_controller=None, macaroon=None, offer=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ConsumeOfferDetailsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ControllerAPIInfoResult(addresses=None, cacert=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ControllerAPIInfoResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ControllerConfigResult(config=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ControllerConfigSet(config=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ControllerCredentialInfo(content=None, models=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ControllerVersionResults(git_commit=None, version=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ControllersChangeResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ControllersChangeResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ControllersChanges(added=None, converted=None, maintained=None, removed=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ControllersSpec(constraints=None, num_controllers=None, placement=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ControllersSpecs(specs=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CreateSecretArg(upsertsecretarg=None, content=None, description=None, expire_time=None, label=None, owner_tag=None, params=None, rotate_policy=None, uri=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CreateSecretArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CreateSpaceParams(cidrs=None, provider_id=None, public=None, space_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CreateSpacesParams(spaces=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CredentialContent(attrs=None, auth_type=None, cloud=None, name=None, valid=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CredentialContentResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.CredentialContentResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DashboardConnectionInfo(error=None, proxy_connection=None, ssh_connection=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DashboardConnectionSSHTunnel(entity=None, host=None, model=None, port=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DeleteSecretArg(label=None, revisions=None, uri=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DeleteSecretArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DeployFromRepositoryArg(applicationname=None, attachstorage=None, charmname=None, configyaml=None, cons=None, devices=None, dryrun=None, placement=None, storage=None, trust=None, base=None, channel=None, endpoint_bindings=None, force=None, num_units=None, resources=None, revision=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DeployFromRepositoryArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DeployFromRepositoryInfo(architecture=None, base=None, channel=None, effective_channel=None, name=None, revision=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DeployFromRepositoryResult(errors=None, info=None, pendingresourceuploads=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DeployFromRepositoryResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyApplicationInfo(destroyed_storage=None, destroyed_units=None, detached_storage=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyApplicationOffers(force=None, offer_urls=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyApplicationParams(application_tag=None, destroy_storage=None, dry_run=None, force=None, max_wait=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyApplicationResult(error=None, info=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyApplicationResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyApplicationsParams(applications=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyConsumedApplicationParams(application_tag=None, force=None, max_wait=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyConsumedApplicationsParams(applications=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyControllerArgs(destroy_models=None, destroy_storage=None, force=None, max_wait=None, model_timeout=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyMachineInfo(destroyed_containers=None, destroyed_storage=None, destroyed_units=None, detached_storage=None, machine_id=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyMachineResult(error=None, info=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyMachineResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyMachinesParams(dry_run=None, force=None, keep=None, machine_tags=None, max_wait=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyModelParams(destroy_storage=None, force=None, max_wait=None, model_tag=None, timeout=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyModelsParams(models=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyRelation(endpoints=None, force=None, max_wait=None, relation_id=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyUnitInfo(destroyed_storage=None, detached_storage=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyUnitParams(destroy_storage=None, dry_run=None, force=None, max_wait=None, unit_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyUnitResult(error=None, info=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyUnitResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DestroyUnitsParams(units=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DetailedStatus(data=None, err=None, info=None, kind=None, life=None, since=None, status=None, version=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DownloadInfoResult(charm_origin=None, url=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DownloadInfoResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.DumpModelRequest(entities=None, simplified=None, **unknown_fields)

Bases: Type

class juju.client._definitions.EndpointFilterAttributes(interface=None, name=None, role=None, **unknown_fields)

Bases: Type

class juju.client._definitions.EndpointRelationData(applicationdata=None, cross_model=None, endpoint=None, related_endpoint=None, relation_id=None, unit_relation_data=None, **unknown_fields)

Bases: Type

class juju.client._definitions.EndpointStatus(application=None, name=None, role=None, subordinate=None, **unknown_fields)

Bases: Type

class juju.client._definitions.EnqueuedActions(actions=None, operation=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Entities(entities=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Entity(tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.EntityAnnotations(annotations=None, entity=None, **unknown_fields)

Bases: Type

class juju.client._definitions.EntityMetrics(error=None, metrics=None, **unknown_fields)

Bases: Type

class juju.client._definitions.EntityPassword(password=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.EntityPasswords(changes=None, **unknown_fields)

Bases: Type

class juju.client._definitions.EntityStatus(data=None, info=None, since=None, status=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Error(code=None, info=None, message=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ErrorResult(error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ErrorResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ExportBundleParams(include_charm_defaults=None, include_series=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ExposedEndpoint(expose_to_cidrs=None, expose_to_spaces=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ExpressionTree(expression=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ExternalControllerInfo(addrs=None, ca_cert=None, controller_alias=None, controller_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FilesystemAttachmentDetails(filesystemattachmentinfo=None, life=None, mount_point=None, read_only=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FilesystemAttachmentInfo(mount_point=None, read_only=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FilesystemDetails(filesystem_tag=None, info=None, life=None, machine_attachments=None, status=None, storage=None, unit_attachments=None, volume_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FilesystemDetailsListResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FilesystemDetailsListResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FilesystemFilter(machines=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FilesystemFilters(filters=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FilesystemInfo(filesystem_id=None, pool=None, size=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FindToolsParams(agentstream=None, arch=None, major=None, number=None, os_type=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FindToolsResult(error=None, list_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FirewallRule(known_service=None, whitelist_cidrs=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FirewallRuleArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.FullStatus(applications=None, branches=None, controller_timestamp=None, filesystems=None, machines=None, model=None, offers=None, relations=None, remote_applications=None, storage=None, volumes=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Generation(applications=None, branch=None, completed=None, completed_by=None, created=None, created_by=None, generation_id=None, **unknown_fields)

Bases: Type

class juju.client._definitions.GenerationApplication(application=None, config=None, pending=None, progress=None, tracking=None, **unknown_fields)

Bases: Type

class juju.client._definitions.GenerationId(generation_id=None, **unknown_fields)

Bases: Type

class juju.client._definitions.GenerationResult(error=None, generation=None, **unknown_fields)

Bases: Type

class juju.client._definitions.GetConstraintsResults(constraints=None, **unknown_fields)

Bases: Type

class juju.client._definitions.GrantRevokeUserSecretArg(applications=None, label=None, uri=None, **unknown_fields)

Bases: Type

class juju.client._definitions.HardwareCharacteristics(arch=None, availability_zone=None, cpu_cores=None, cpu_power=None, mem=None, root_disk=None, root_disk_source=None, tags=None, virt_type=None, **unknown_fields)

Bases: Type

class juju.client._definitions.History(error=None, statuses=None, **unknown_fields)

Bases: Type

class juju.client._definitions.HostPort(address=None, cidr=None, config_type=None, is_secondary=None, port=None, scope=None, space_id=None, space_name=None, type_=None, value=None, **unknown_fields)

Bases: Type

class juju.client._definitions.HostedModelConfig(cloud_spec=None, config=None, error=None, name=None, owner=None, **unknown_fields)

Bases: Type

class juju.client._definitions.HostedModelConfigsResults(models=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ImageMetadataFilter(arches=None, region=None, root_storage_type=None, stream=None, versions=None, virt_type=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ImportStorageDetails(storage_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ImportStorageParams(kind=None, pool=None, provider_id=None, storage_name=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ImportStorageResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ImportStorageResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.InitiateMigrationArgs(specs=None, **unknown_fields)

Bases: Type

class juju.client._definitions.InitiateMigrationResult(error=None, migration_id=None, model_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.InitiateMigrationResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.InstanceType(arches=None, cost=None, cpu_cores=None, memory=None, name=None, root_disk=None, virt_type=None, **unknown_fields)

Bases: Type

class juju.client._definitions.InstanceTypesResult(cost_currency=None, cost_divisor=None, cost_unit=None, error=None, instance_types=None, **unknown_fields)

Bases: Type

class juju.client._definitions.InstanceTypesResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.IntResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.InvalidateCredentialArg(reason=None, **unknown_fields)

Bases: Type

class juju.client._definitions.IsMeteredResult(metered=None, **unknown_fields)

Bases: Type

class juju.client._definitions.LXDProfile(config=None, description=None, devices=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListCloudImageMetadataResult(result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListCloudInfo(clouddetails=None, user_access=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListCloudInfoResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListCloudInfoResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListCloudsRequest(all_=None, user_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListFirewallRulesResults(rules=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListResourcesArgs(entities=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListSSHKeys(entities=None, mode=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListSecretBackendsArgs(names=None, reveal=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListSecretBackendsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListSecretResult(access=None, create_time=None, description=None, label=None, latest_expire_time=None, latest_revision=None, latest_revision_checksum=None, next_rotate_time=None, owner_tag=None, revisions=None, rotate_policy=None, update_time=None, uri=None, value=None, version=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListSecretResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListSecretsArgs(filter_=None, show_secrets=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListSpacesResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ListSubnetsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.LoginRequest(auth_tag=None, bakery_version=None, cli_args=None, client_version=None, credentials=None, macaroons=None, nonce=None, token=None, user_data=None, **unknown_fields)

Bases: Type

class juju.client._definitions.LoginResult(bakery_discharge_required=None, controller_tag=None, discharge_required=None, discharge_required_error=None, facades=None, model_tag=None, public_dns_name=None, server_version=None, servers=None, user_info=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Macaroon(**unknown_fields)

Bases: Type

class juju.client._definitions.MachineHardware(arch=None, availability_zone=None, cores=None, cpu_power=None, mem=None, root_disk=None, tags=None, virt_type=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MachineStatus(agent_status=None, base=None, constraints=None, containers=None, display_name=None, dns_name=None, hardware=None, has_vote=None, hostname=None, id_=None, instance_id=None, instance_status=None, ip_addresses=None, jobs=None, lxd_profiles=None, modification_status=None, network_interfaces=None, primary_controller_machine=None, wants_vote=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MapResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MapResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MetadataImageIds(image_ids=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MetadataSaveParams(metadata=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MeterStatus(color=None, message=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MeterStatusParam(code=None, info=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MeterStatusParams(statues=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MetricResult(key=None, labels=None, time=None, unit=None, value=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MetricResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MigrationSpec(model_tag=None, target_info=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MigrationTargetInfo(addrs=None, auth_tag=None, ca_cert=None, controller_alias=None, controller_tag=None, macaroons=None, password=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Model(name=None, owner_tag=None, type_=None, uuid=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelAccess(access=None, model=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelApplicationInfo(name=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelBlockInfo(blocks=None, model_uuid=None, name=None, owner_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelBlockInfoList(models=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelConfigResults(config=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelCreateArgs(cloud_tag=None, config=None, credential=None, name=None, owner_tag=None, region=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelDefaultValues(cloud_region=None, cloud_tag=None, config=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelDefaults(controller=None, default=None, regions=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelDefaultsResult(config=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelDefaultsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelEntityCount(count=None, entity=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelFilesystemInfo(detachable=None, id_=None, message=None, provider_id=None, status=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelInfo(agent_version=None, cloud_credential_tag=None, cloud_credential_validity=None, cloud_region=None, cloud_tag=None, controller_uuid=None, default_base=None, default_series=None, is_controller=None, life=None, machines=None, migration=None, name=None, owner_tag=None, provider_type=None, secret_backends=None, sla=None, status=None, supported_features=None, type_=None, users=None, uuid=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelInfoResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelInfoResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelInstanceTypesConstraint(value=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelInstanceTypesConstraints(constraints=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelMachineInfo(display_name=None, ha_primary=None, hardware=None, has_vote=None, id_=None, instance_id=None, message=None, status=None, wants_vote=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelMigrationStatus(end=None, start=None, status=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelParam(model_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelSLA(modelslainfo=None, creds=None, level=None, owner=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelSLAInfo(level=None, owner=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelSequencesResult(sequences=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelSet(config=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelStatus(application_count=None, applications=None, error=None, filesystems=None, hosted_machine_count=None, life=None, machines=None, model_tag=None, owner_tag=None, type_=None, unit_count=None, volumes=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelStatusInfo(available_version=None, cloud_tag=None, meter_status=None, model_status=None, name=None, region=None, sla=None, type_=None, version=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelStatusResults(models=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelSummariesRequest(all_=None, user_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelSummary(agent_version=None, cloud_credential_tag=None, cloud_region=None, cloud_tag=None, controller_uuid=None, counts=None, default_series=None, is_controller=None, last_connection=None, life=None, migration=None, name=None, owner_tag=None, provider_type=None, sla=None, status=None, type_=None, user_access=None, uuid=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelSummaryResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelSummaryResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelTag(**unknown_fields)

Bases: Type

class juju.client._definitions.ModelUnset(keys=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelUnsetKeys(cloud_region=None, cloud_tag=None, keys=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelUserInfo(access=None, display_name=None, last_connection=None, model_tag=None, user=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelUserInfoResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelUserInfoResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModelVolumeInfo(detachable=None, id_=None, message=None, provider_id=None, status=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModifyCloudAccess(access=None, action=None, cloud_tag=None, user_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModifyCloudAccessRequest(changes=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModifyControllerAccess(access=None, action=None, user_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModifyControllerAccessRequest(changes=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModifyModelAccess(access=None, action=None, model_tag=None, user_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModifyModelAccessRequest(changes=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModifyOfferAccess(access=None, action=None, offer_url=None, user_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModifyOfferAccessRequest(changes=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ModifyUserSSHKeys(ssh_keys=None, user=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MoveSubnetsParam(force=None, space_tag=None, subnets=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MoveSubnetsParams(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MoveSubnetsResult(error=None, moved_subnets=None, new_space=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MoveSubnetsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.MovedSubnet(cidr=None, old_space=None, subnet=None, **unknown_fields)

Bases: Type

class juju.client._definitions.NetworkInterface(dns_nameservers=None, gateway=None, ip_addresses=None, is_up=None, mac_address=None, space=None, **unknown_fields)

Bases: Type

class juju.client._definitions.NotifyWatchResult(notifywatcherid=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.NotifyWatchResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.OfferConnection(endpoint=None, ingress_subnets=None, relation_id=None, source_model_tag=None, status=None, username=None, **unknown_fields)

Bases: Type

class juju.client._definitions.OfferFilter(allowed_users=None, application_description=None, application_name=None, application_user=None, connected_users=None, endpoints=None, model_name=None, offer_name=None, owner_name=None, **unknown_fields)

Bases: Type

class juju.client._definitions.OfferFilters(filters=None, **unknown_fields)

Bases: Type

class juju.client._definitions.OfferURLs(bakery_version=None, offer_urls=None, **unknown_fields)

Bases: Type

class juju.client._definitions.OfferUserDetails(access=None, display_name=None, user=None, **unknown_fields)

Bases: Type

class juju.client._definitions.OperationQueryArgs(actions=None, applications=None, limit=None, machines=None, offset=None, status=None, units=None, **unknown_fields)

Bases: Type

class juju.client._definitions.OperationResult(actions=None, completed=None, enqueued=None, error=None, fail=None, operation=None, started=None, status=None, summary=None, **unknown_fields)

Bases: Type

class juju.client._definitions.OperationResults(results=None, truncated=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Payload(class_=None, id_=None, labels=None, machine=None, status=None, type_=None, unit=None, **unknown_fields)

Bases: Type

class juju.client._definitions.PayloadListArgs(patterns=None, **unknown_fields)

Bases: Type

class juju.client._definitions.PayloadListResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.PendingResourceUpload(filename=None, name=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Placement(directive=None, scope=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ProvisioningScriptParams(data_dir=None, disable_package_commands=None, machine_id=None, nonce=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ProvisioningScriptResult(script=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Proxy(config=None, type_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.QueryApplicationOffersResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.QueryApplicationOffersResultsV5(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RedirectInfoResult(ca_cert=None, servers=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RegionDefaults(region_name=None, value=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RelationData(inscope=None, unitdata=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RelationStatus(endpoints=None, id_=None, interface=None, key=None, scope=None, status=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RelationSuspendedArg(message=None, relation_id=None, suspended=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RelationSuspendedArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoteApplicationInfo(description=None, endpoints=None, icon_url_path=None, model_tag=None, name=None, offer_url=None, source_model_label=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoteApplicationInfoResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoteApplicationInfoResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoteApplicationStatus(endpoints=None, err=None, life=None, offer_name=None, offer_url=None, relations=None, status=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoteEndpoint(interface=None, limit=None, name=None, role=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoteSpace(cloud_type=None, name=None, provider_attributes=None, provider_id=None, subnets=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoveBlocksArgs(all_=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoveSecretBackendArg(force=None, name=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoveSecretBackendArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoveSpaceParam(dry_run=None, force=None, space=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoveSpaceParams(space_param=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoveSpaceResult(bindings=None, constraints=None, controller_settings=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoveSpaceResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoveStorage(storage=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RemoveStorageInstance(destroy_attachments=None, destroy_storage=None, force=None, max_wait=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RenameSpaceParams(from_space_tag=None, to_space_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RenameSpacesParams(changes=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ResolveCharmWithChannel(charm_origin=None, reference=None, switch_charm=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ResolveCharmWithChannelResult(charm_origin=None, error=None, supported_bases=None, url=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ResolveCharmWithChannelResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ResolveCharmsWithChannel(macaroon=None, resolve=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ResourcesResult(errorresult=None, charm_store_resources=None, error=None, resources=None, unit_resources=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ResourcesResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RetryProvisioningArgs(all_=None, machines=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RevokeCredentialArg(force=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RevokeCredentialArgs(credentials=None, **unknown_fields)

Bases: Type

class juju.client._definitions.RunParams(applications=None, commands=None, execution_group=None, machines=None, parallel=None, timeout=None, units=None, workload_context=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SSHAddressResult(address=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SSHAddressResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SSHAddressesResult(addresses=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SSHAddressesResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SSHProxyResult(use_proxy=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SSHPublicKeysResult(error=None, public_keys=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SSHPublicKeysResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ScaleApplicationInfo(num_units=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ScaleApplicationParams(application_tag=None, force=None, scale=None, scale_change=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ScaleApplicationResult(error=None, info=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ScaleApplicationResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ScaleApplicationsParams(applications=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SecretBackend(backend_type=None, config=None, name=None, token_rotate_interval=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SecretBackendResult(error=None, id_=None, message=None, num_secrets=None, result=None, status=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SecretContentParams(checksum=None, data=None, value_ref=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SecretRevision(backend_name=None, create_time=None, expire_time=None, revision=None, update_time=None, value_ref=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SecretValueRef(backend_id=None, revision_id=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SecretValueResult(data=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SecretsFilter(label=None, owner_tag=None, revision=None, uri=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SetConstraints(application=None, constraints=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SetModelDefaults(config=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ShowSpaceResult(applications=None, error=None, machine_count=None, space=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ShowSpaceResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Space(error=None, id_=None, name=None, subnets=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StatusHistoryFilter(date=None, delta=None, exclude=None, size=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StatusHistoryRequest(filter_=None, historykind=None, size=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StatusHistoryRequests(requests=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StatusHistoryResult(error=None, history=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StatusHistoryResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StatusParams(include_storage=None, patterns=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageAddParams(name=None, storage=None, unit=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageAttachmentDetails(life=None, location=None, machine_tag=None, storage_tag=None, unit_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageAttachmentId(storage_tag=None, unit_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageAttachmentIds(ids=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageConstraints(count=None, pool=None, size=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageDetachmentParams(force=None, ids=None, max_wait=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageDetails(attachments=None, kind=None, life=None, owner_tag=None, persistent=None, status=None, storage_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageDetailsListResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageDetailsListResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageDetailsResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageDetailsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StorageFilter(**unknown_fields)

Bases: Type

class juju.client._definitions.StorageFilters(filters=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StoragePool(attrs=None, name=None, provider=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StoragePoolArgs(pools=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StoragePoolDeleteArg(name=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StoragePoolDeleteArgs(pools=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StoragePoolFilter(names=None, providers=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StoragePoolFilters(filters=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StoragePoolsResult(error=None, storage_pools=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StoragePoolsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StoragesAddParams(storages=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StringResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StringResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StringsResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StringsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StringsWatchResult(changes=None, error=None, watcher_id=None, **unknown_fields)

Bases: Type

class juju.client._definitions.StringsWatchResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Subnet(cidr=None, life=None, provider_id=None, provider_network_id=None, provider_space_id=None, space_tag=None, status=None, vlan_tag=None, zones=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SubnetV2(subnet=None, cidr=None, id_=None, life=None, provider_id=None, provider_network_id=None, provider_space_id=None, space_tag=None, status=None, vlan_tag=None, zones=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SubnetsFilters(space_tag=None, zone=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SubnetsResult(error=None, subnets=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SubnetsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SummaryWatcherID(watcher_id=None, **unknown_fields)

Bases: Type

class juju.client._definitions.SupportedFeature(description=None, name=None, version=None, **unknown_fields)

Bases: Type

class juju.client._definitions.TaggedCredential(credential=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.TaggedCredentials(credentials=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Tools(sha256=None, size=None, url=None, version=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UnitInfoResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UnitInfoResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UnitResources(entity=None, download_progress=None, resources=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UnitResult(address=None, charm=None, leader=None, life=None, machine=None, opened_ports=None, provider_id=None, public_address=None, relation_data=None, tag=None, workload_version=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UnitStatus(address=None, agent_status=None, charm=None, leader=None, machine=None, opened_ports=None, provider_id=None, public_address=None, subordinates=None, workload_status=None, workload_version=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UnitsResolved(all_=None, retry=None, tags=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UnsetModelDefaults(keys=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpdateChannelArg(channel=None, force=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpdateChannelArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpdateCloudArgs(clouds=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpdateCredentialArgs(credentials=None, force=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpdateCredentialModelResult(errors=None, name=None, uuid=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpdateCredentialResult(error=None, models=None, tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpdateCredentialResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpdateSecretBackendArg(config=None, force=None, name=None, name_change=None, reset=None, token_rotate_interval=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpdateSecretBackendArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpdateUserSecretArg(upsertsecretarg=None, auto_prune=None, content=None, description=None, existing_label=None, expire_time=None, label=None, params=None, rotate_policy=None, uri=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpdateUserSecretArgs(args=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpgradeModelParams(agent_stream=None, dry_run=None, ignore_agent_versions=None, model_tag=None, target_version=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpgradeModelResult(chosen_version=None, error=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpgradeSeriesNotificationParam(entity=None, watcher_id=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpgradeSeriesNotificationParams(params=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpgradeSeriesUnitsResult(error=None, unit_names=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpgradeSeriesUnitsResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UpsertSecretArg(content=None, description=None, expire_time=None, label=None, params=None, rotate_policy=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UserAccess(access=None, user_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UserAccessResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UserAccessResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UserCloud(cloud_tag=None, user_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UserClouds(user_clouds=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UserInfo(access=None, created_by=None, date_created=None, disabled=None, display_name=None, last_connection=None, username=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UserInfoRequest(entities=None, include_disabled=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UserInfoResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UserInfoResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UserModel(last_connection=None, model=None, **unknown_fields)

Bases: Type

class juju.client._definitions.UserModelList(user_models=None, **unknown_fields)

Bases: Type

class juju.client._definitions.Value(allocate_public_ip=None, arch=None, container=None, cores=None, cpu_power=None, image_id=None, instance_role=None, instance_type=None, mem=None, root_disk=None, root_disk_source=None, spaces=None, tags=None, virt_type=None, zones=None, **unknown_fields)

Bases: Type

class juju.client._definitions.VolumeAttachmentDetails(volumeattachmentinfo=None, bus_address=None, device_link=None, device_name=None, life=None, plan_info=None, read_only=None, **unknown_fields)

Bases: Type

class juju.client._definitions.VolumeAttachmentInfo(bus_address=None, device_link=None, device_name=None, plan_info=None, read_only=None, **unknown_fields)

Bases: Type

class juju.client._definitions.VolumeAttachmentPlanInfo(device_attributes=None, device_type=None, **unknown_fields)

Bases: Type

class juju.client._definitions.VolumeDetails(info=None, life=None, machine_attachments=None, status=None, storage=None, unit_attachments=None, volume_tag=None, **unknown_fields)

Bases: Type

class juju.client._definitions.VolumeDetailsListResult(error=None, result=None, **unknown_fields)

Bases: Type

class juju.client._definitions.VolumeDetailsListResults(results=None, **unknown_fields)

Bases: Type

class juju.client._definitions.VolumeFilter(machines=None, **unknown_fields)

Bases: Type

class juju.client._definitions.VolumeFilters(filters=None, **unknown_fields)

Bases: Type

class juju.client._definitions.VolumeInfo(hardware_id=None, persistent=None, pool=None, size=None, volume_id=None, wwn=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ZoneResult(available=None, error=None, name=None, **unknown_fields)

Bases: Type

class juju.client._definitions.ZoneResults(results=None, **unknown_fields)

Bases: Type

juju.client._client module

class juju.client._client.ActionFacade

Bases: TypeFactory

class juju.client._client.AdminFacade

Bases: TypeFactory

class juju.client._client.AllModelWatcherFacade

Bases: TypeFactory

class juju.client._client.AllWatcherFacade

Bases: TypeFactory

class juju.client._client.AnnotationsFacade

Bases: TypeFactory

class juju.client._client.ApplicationFacade

Bases: TypeFactory

class juju.client._client.ApplicationOffersFacade

Bases: TypeFactory

class juju.client._client.BackupsFacade

Bases: TypeFactory

class juju.client._client.BlockFacade

Bases: TypeFactory

class juju.client._client.BundleFacade

Bases: TypeFactory

class juju.client._client.CharmsFacade

Bases: TypeFactory

class juju.client._client.ClientFacade

Bases: TypeFactory

class juju.client._client.CloudFacade

Bases: TypeFactory

class juju.client._client.ControllerFacade

Bases: TypeFactory

class juju.client._client.CredentialManagerFacade

Bases: TypeFactory

class juju.client._client.FacadeVersions

Bases: TypeFactory

class juju.client._client.FirewallRulesFacade

Bases: TypeFactory

class juju.client._client.HighAvailabilityFacade

Bases: TypeFactory

class juju.client._client.ImageMetadataManagerFacade

Bases: TypeFactory

class juju.client._client.KeyManagerFacade

Bases: TypeFactory

class juju.client._client.MachineManagerFacade

Bases: TypeFactory

class juju.client._client.MetricsDebugFacade

Bases: TypeFactory

class juju.client._client.ModelConfigFacade

Bases: TypeFactory

class juju.client._client.ModelGenerationFacade

Bases: TypeFactory

class juju.client._client.ModelManagerFacade

Bases: TypeFactory

class juju.client._client.ModelUpgraderFacade

Bases: TypeFactory

class juju.client._client.PayloadsFacade

Bases: TypeFactory

class juju.client._client.PingerFacade

Bases: TypeFactory

class juju.client._client.ResourcesFacade

Bases: TypeFactory

class juju.client._client.SSHClientFacade

Bases: TypeFactory

class juju.client._client.SecretBackendsFacade

Bases: TypeFactory

class juju.client._client.SecretsFacade

Bases: TypeFactory

class juju.client._client.SpacesFacade

Bases: TypeFactory

class juju.client._client.StorageFacade

Bases: TypeFactory

class juju.client._client.SubnetsFacade

Bases: TypeFactory

class juju.client._client.TypeFactory

Bases: object

classmethod best_facade_version(connection)

Returns the best facade version for a given facade. This will help with trying to provide different functionality for different facade versions.

@param connection: initialized Connection object.

classmethod from_connection(connection)

Given a connected Connection object, return an initialized and connected instance of an API Interface matching the name of this class.

@param connection: initialized Connection object.

class juju.client._client.UserManagerFacade

Bases: TypeFactory

juju.client._client.lookup_facade(name, version)

Given a facade name and version, attempt to pull that facade out of the correct client<version>.py file.

juju.client._client1 module

class juju.client._client1.CredentialManagerFacade

Bases: Type

coroutine InvalidateModelCredential(reason=None)

InvalidateModelCredential marks the cloud credential for this model as invalid.

reason : str Returns -> ErrorResult

name = 'CredentialManager'

version = 1

class juju.client._client1.FirewallRulesFacade

Bases: Type

coroutine ListFirewallRules()

ListFirewallRules returns all the firewall rules.

Returns -> ListFirewallRulesResults

coroutine SetFirewallRules(args=None)

SetFirewallRules creates or updates the specified firewall rules.

args : typing.Sequence[~FirewallRule] Returns -> ErrorResults

name = 'FirewallRules'

version = 1

class juju.client._client1.ImageMetadataManagerFacade

Bases: Type

coroutine Delete(image_ids=None)

Delete deletes cloud image metadata for given image ids. It supports bulk calls.

image_ids : typing.Sequence[str] Returns -> ErrorResults

coroutine List(arches=None, region=None, root_storage_type=None, stream=None, versions=None, virt_type=None)

List returns all found cloud image metadata that satisfy given filter. Returned list contains metadata ordered by priority.

arches : typing.Sequence[str] region : str root_storage_type : str stream : str versions : typing.Sequence[str] virt_type : str Returns -> ListCloudImageMetadataResult

coroutine Save(metadata=None)

Save stores given cloud image metadata. It supports bulk calls.

metadata : typing.Sequence[~CloudImageMetadataList] Returns -> ErrorResults

name = 'ImageMetadataManager'

version = 1

class juju.client._client1.KeyManagerFacade

Bases: Type

coroutine AddKeys(ssh_keys=None, user=None)

AddKeys adds new authorised ssh keys for the specified user.

ssh_keys : typing.Sequence[str] user : str Returns -> ErrorResults

coroutine DeleteKeys(ssh_keys=None, user=None)

DeleteKeys deletes the authorised ssh keys for the specified user.

ssh_keys : typing.Sequence[str] user : str Returns -> ErrorResults

coroutine ImportKeys(ssh_keys=None, user=None)

ImportKeys imports new authorised ssh keys from the specified key ids for the specified user.

ssh_keys : typing.Sequence[str] user : str Returns -> ErrorResults

coroutine ListKeys(entities=None, mode=None)

ListKeys returns the authorised ssh keys for the specified users.

entities : Entities mode : bool Returns -> StringsResults

name = 'KeyManager'

version = 1

class juju.client._client1.ModelUpgraderFacade

Bases: Type

coroutine AbortModelUpgrade(model_tag=None)

AbortModelUpgrade aborts and archives the model upgrade synchronisation record, if any.

model_tag : str Returns -> None

coroutine UpgradeModel(agent_stream=None, dry_run=None, ignore_agent_versions=None, model_tag=None, target_version=None)

UpgradeModel upgrades a model.

agent_stream : str dry_run : bool ignore_agent_versions : bool model_tag : str target_version : Number Returns -> UpgradeModelResult

name = 'ModelUpgrader'

version = 1

class juju.client._client1.PayloadsFacade

Bases: Type

coroutine List(patterns=None)

List builds the list of payloads being tracked for the given unit and IDs. If no IDs are provided then all tracked payloads for the unit are returned.

patterns : typing.Sequence[str] Returns -> PayloadListResults

name = 'Payloads'

version = 1

class juju.client._client1.PingerFacade

Bases: Type

coroutine Ping()

Returns -> None

coroutine Stop()

Returns -> None

name = 'Pinger'

version = 1

class juju.client._client1.SecretBackendsFacade

Bases: Type

coroutine AddSecretBackends(args=None)

AddSecretBackends adds new secret backends.

args : typing.Sequence[~AddSecretBackendArg] Returns -> ErrorResults

coroutine ListSecretBackends(names=None, reveal=None)

ListSecretBackends lists available secret backends.

names : typing.Sequence[str] reveal : bool Returns -> ListSecretBackendsResults

coroutine RemoveSecretBackends(args=None)

RemoveSecretBackends removes secret backends.

args : typing.Sequence[~RemoveSecretBackendArg] Returns -> ErrorResults

coroutine UpdateSecretBackends(args=None)

UpdateSecretBackends updates secret backends.

args : typing.Sequence[~UpdateSecretBackendArg] Returns -> ErrorResults

name = 'SecretBackends'

version = 1

class juju.client._client1.SecretsFacade

Bases: Type

coroutine ListSecrets(filter_=None, show_secrets=None)

ListSecrets lists available secrets.

filter_ : SecretsFilter show_secrets : bool Returns -> ListSecretResults

name = 'Secrets'

version = 1

juju.client._client2 module

class juju.client._client2.AnnotationsFacade

Bases: Type

coroutine Get(entities=None)

Get returns annotations for given entities. If annotations cannot be retrieved for a given entity, an error is returned. Each entity is treated independently and, hence, will fail or succeed independently.

entities : typing.Sequence[~Entity] Returns -> AnnotationsGetResults

coroutine Set(annotations=None)

Set stores annotations for given entities

annotations : typing.Sequence[~EntityAnnotations] Returns -> ErrorResults

name = 'Annotations'

version = 2

class juju.client._client2.BlockFacade

Bases: Type

coroutine List()

List implements Block.List().

Returns -> BlockResults

coroutine SwitchBlockOff(message=None, type_=None)

SwitchBlockOff implements Block.SwitchBlockOff().

message : str type_ : str Returns -> ErrorResult

coroutine SwitchBlockOn(message=None, type_=None)

SwitchBlockOn implements Block.SwitchBlockOn().

message : str type_ : str Returns -> ErrorResult

name = 'Block'

version = 2

class juju.client._client2.HighAvailabilityFacade

Bases: Type

coroutine EnableHA(specs=None)

EnableHA adds controller machines as necessary to ensure the controller has the number of machines specified.

specs : typing.Sequence[~ControllersSpec] Returns -> ControllersChangeResults

name = 'HighAvailability'

version = 2

class juju.client._client2.MetricsDebugFacade

Bases: Type

coroutine GetMetrics(entities=None)

GetMetrics returns all metrics stored by the state server.

entities : typing.Sequence[~Entity] Returns -> MetricResults

coroutine SetMeterStatus(statues=None)

SetMeterStatus sets meter statuses for entities.

statues : typing.Sequence[~MeterStatusParam] Returns -> ErrorResults

name = 'MetricsDebug'

version = 2

class juju.client._client2.SecretsFacade

Bases: Type

coroutine CreateSecrets(args=None)

CreateSecrets creates new secrets.

args : typing.Sequence[~CreateSecretArg] Returns -> StringResults

coroutine GrantSecret(applications=None, label=None, uri=None)

GrantSecret grants access to a user secret.

applications : typing.Sequence[str] label : str uri : str Returns -> ErrorResults

coroutine ListSecrets(filter_=None, show_secrets=None)

ListSecrets lists available secrets.

filter_ : SecretsFilter show_secrets : bool Returns -> ListSecretResults

coroutine RemoveSecrets(args=None)

RemoveSecrets remove user secret.

args : typing.Sequence[~DeleteSecretArg] Returns -> ErrorResults

coroutine RevokeSecret(applications=None, label=None, uri=None)

RevokeSecret revokes access to a user secret.

applications : typing.Sequence[str] label : str uri : str Returns -> ErrorResults

coroutine UpdateSecrets(args=None)

UpdateSecrets creates new secrets.

args : typing.Sequence[~UpdateUserSecretArg] Returns -> ErrorResults

name = 'Secrets'

version = 2

juju.client._client3 module

class juju.client._client3.AdminFacade

Bases: Type

coroutine Login(auth_tag=None, bakery_version=None, cli_args=None, client_version=None, credentials=None, macaroons=None, nonce=None, token=None, user_data=None)

Login logs in with the provided credentials. All subsequent requests on the connection will act as the authenticated user.

auth_tag : str bakery_version : int cli_args : str client_version : str credentials : str macaroons : typing.Sequence[~Macaroon] nonce : str token : str user_data : str Returns -> LoginResult

coroutine RedirectInfo()

RedirectInfo returns redirected host information for the model. In Juju it always returns an error because the Juju controller does not multiplex controllers.

Returns -> RedirectInfoResult

name = 'Admin'

version = 3

class juju.client._client3.AllWatcherFacade

Bases: Type

coroutine Next()

Next will return the current state of everything on the first call and subsequent calls will

Returns -> AllWatcherNextResults

coroutine Stop()

Stop stops the watcher.

Returns -> None

connect(connection)

classmethod from_json(data: juju.client.facade.Type | str | dict[str, Any] | list[Any]) → Optional[Self]

get(key, default=None)

name = 'AllWatcher'

coroutine rpc(msg)

serialize() → dict[str, _Json]

to_json() → str

version = 3

class juju.client._client3.BackupsFacade

Bases: Type

coroutine Create(no_download=None, notes=None)

Create is the API method that requests juju to create a new backup of its state.

no_download : bool notes : str Returns -> BackupsMetadataResult

name = 'Backups'

version = 3

class juju.client._client3.ModelConfigFacade

Bases: Type

coroutine GetModelConstraints()

GetModelConstraints returns the constraints for the model.

Returns -> GetConstraintsResults

coroutine ModelGet()

ModelGet implements the server-side part of the model-config CLI command.

Returns -> ModelConfigResults

coroutine ModelSet(config=None)

ModelSet implements the server-side part of the set-model-config CLI command.

config : typing.Mapping[str, typing.Any] Returns -> None

coroutine ModelUnset(keys=None)

ModelUnset implements the server-side part of the set-model-config CLI command.

keys : typing.Sequence[str] Returns -> None

coroutine SLALevel()

SLALevel returns the current sla level for the model.

Returns -> StringResult

coroutine Sequences()

Sequences returns the model’s sequence names and next values.

Returns -> ModelSequencesResult

coroutine SetModelConstraints(application=None, constraints=None)

SetModelConstraints sets the constraints for the model.

application : str constraints : Value Returns -> None

coroutine SetSLALevel(modelslainfo=None, creds=None, level=None, owner=None)

SetSLALevel sets the sla level on the model.

modelslainfo : ModelSLAInfo creds : typing.Sequence[int] level : str owner : str Returns -> None

name = 'ModelConfig'

version = 3

class juju.client._client3.ResourcesFacade

Bases: Type

coroutine AddPendingResources(application_tag='', charm_url='', charm_origin=None, resources=None)

Fix the calling signature of AddPendingResources.

The ResourcesFacade doesn’t conform to the standard facade pattern in the Juju source, which leads to the schemagened code not matching up properly with the actual calling convention in the API. There is work planned to fix this in Juju, but we have to work around it for now.

application_tag : str charm_url : str resources : typing.Sequence<+T_co>[~CharmResource]<~CharmResource> Returns -> typing.Union[_ForwardRef(‘ErrorResult’),

typing.Sequence<+T_co>[str]]

coroutine ListResources(entities=None)

ListResources returns the list of resources for the given application.

entities : typing.Sequence[~Entity] Returns -> ResourcesResults

connect(connection)

classmethod from_json(data: juju.client.facade.Type | str | dict[str, Any] | list[Any]) → Optional[Self]

get(key, default=None)

name = 'Resources'

coroutine rpc(msg: dict[str, _RichJson]) → _Json

serialize() → dict[str, _Json]

to_json() → str

version = 3

class juju.client._client3.UserManagerFacade

Bases: Type

coroutine AddUser(users=None)

AddUser adds a user with a username, and either a password or a randomly generated secret key which will be returned.

users : typing.Sequence[~AddUser] Returns -> AddUserResults

coroutine DisableUser(entities=None)

DisableUser disables one or more users. If the user is already disabled, the action is considered a success.

entities : typing.Sequence[~Entity] Returns -> ErrorResults

coroutine EnableUser(entities=None)

EnableUser enables one or more users. If the user is already enabled, the action is considered a success.

entities : typing.Sequence[~Entity] Returns -> ErrorResults

coroutine ModelUserInfo(entities=None)

ModelUserInfo returns information on all users in the model.

entities : typing.Sequence[~Entity] Returns -> ModelUserInfoResults

coroutine RemoveUser(entities=None)

RemoveUser permanently removes a user from the current controller for each entity provided. While the user is permanently removed we keep it’s information around for auditing purposes. TODO(redir): Add information about getting deleted user information when we add that capability.

entities : typing.Sequence[~Entity] Returns -> ErrorResults

coroutine ResetPassword(entities=None)

ResetPassword resets password for supplied users by invalidating current passwords (if any) and generating new random secret keys which will be returned. Users cannot reset their own password.

entities : typing.Sequence[~Entity] Returns -> AddUserResults

coroutine SetPassword(changes=None)

SetPassword changes the stored password for the specified users.

changes : typing.Sequence[~EntityPassword] Returns -> ErrorResults

coroutine UserInfo(entities=None, include_disabled=None)

UserInfo returns information on a user.

entities : typing.Sequence[~Entity] include_disabled : bool Returns -> UserInfoResults

name = 'UserManager'

version = 3

juju.client._client4 module

class juju.client._client4.AllModelWatcherFacade

Bases: Type

coroutine Next()

Next will return the current state of everything on the first call and subsequent calls will

Returns -> AllWatcherNextResults

coroutine Stop()

Stop stops the watcher.

Returns -> None

name = 'AllModelWatcher'

coroutine rpc(msg)

Patch rpc method to add Id.

version = 4

class juju.client._client4.ApplicationOffersFacade

Bases: Type

coroutine ApplicationOffers(bakery_version=None, offer_urls=None)

ApplicationOffers gets details about remote applications that match given URLs.

bakery_version : int offer_urls : typing.Sequence[str] Returns -> ApplicationOffersResults

coroutine DestroyOffers(force=None, offer_urls=None)

DestroyOffers removes the offers specified by the given URLs, forcing if necessary.

force : bool offer_urls : typing.Sequence[str] Returns -> ErrorResults

coroutine FindApplicationOffers(filters=None)

FindApplicationOffers gets details about remote applications that match given filter.

filters : typing.Sequence[~OfferFilter] Returns -> QueryApplicationOffersResults

coroutine GetConsumeDetails(offer_urls=None, user_tag=None)

GetConsumeDetails returns the details necessary to pass to another model to allow the specified args user to consume the offers represented by the args URLs.

offer_urls : OfferURLs user_tag : str Returns -> ConsumeOfferDetailsResults

coroutine ListApplicationOffers(filters=None)

ListApplicationOffers gets deployed details about application offers that match given filter. The results contain details about the deployed applications such as connection count.

filters : typing.Sequence[~OfferFilter] Returns -> QueryApplicationOffersResults

coroutine ModifyOfferAccess(changes=None)

ModifyOfferAccess changes the application offer access granted to users.

changes : typing.Sequence[~ModifyOfferAccess] Returns -> ErrorResults

coroutine Offer(offers=None)

Offer makes application endpoints available for consumption at a specified URL.

offers : typing.Sequence[~AddApplicationOffer] Returns -> ErrorResults

coroutine RemoteApplicationInfo(bakery_version=None, offer_urls=None)

RemoteApplicationInfo returns information about the requested remote application. This call currently has no client side API, only there for the Dashboard at this stage.

bakery_version : int offer_urls : typing.Sequence[str] Returns -> RemoteApplicationInfoResults

name = 'ApplicationOffers'

version = 4

class juju.client._client4.ModelGenerationFacade

Bases: Type

coroutine AbortBranch(branch=None)

AbortBranch aborts the input branch, marking it complete. However no changes are made applicable to the whole model. No units may be assigned to the branch when aborting.

branch : str Returns -> ErrorResult

coroutine AddBranch(branch=None)

AddBranch adds a new branch with the input name to the model.

branch : str Returns -> ErrorResult

coroutine BranchInfo(branches=None, detailed=None)

BranchInfo will return details of branch identified by the input argument, including units on the branch and the configuration disjoint with the master generation. An error is returned if no in-flight branch matching in input is found.

branches : typing.Sequence[str] detailed : bool Returns -> BranchResults

coroutine CommitBranch(branch=None)

CommitBranch commits the input branch, making its changes applicable to the whole model and marking it complete.

branch : str Returns -> IntResult

coroutine HasActiveBranch(branch=None)

HasActiveBranch returns a true result if the input model has an “in-flight” branch matching the input name.

branch : str Returns -> BoolResult

coroutine ListCommits()

ListCommits will return the commits, hence only branches with generation_id higher than 0

Returns -> BranchResults

coroutine ShowCommit(generation_id=None)

ShowCommit will return details a commit given by its generationId An error is returned if either no branch can be found corresponding to the generation id. Or the generation id given is below 1.

generation_id : int Returns -> GenerationResult

coroutine TrackBranch(branch=None, entities=None, num_units=None)

TrackBranch marks the input units and/or applications as tracking the input branch, causing them to realise changes made under that branch.

branch : str entities : typing.Sequence[~Entity] num_units : int Returns -> ErrorResults

name = 'ModelGeneration'

version = 4

class juju.client._client4.SSHClientFacade

Bases: Type

coroutine AllAddresses(entities=None)

AllAddresses reports all addresses that might have SSH listening for each entity in args. The result is sorted with public addresses first. Machines and units are supported as entity types.

entities : typing.Sequence[~Entity] Returns -> SSHAddressesResults

coroutine ModelCredentialForSSH()

ModelCredentialForSSH returns a cloud spec for ssh purpose. This facade call is only used for k8s model.

Returns -> CloudSpecResult

coroutine PrivateAddress(entities=None)

PrivateAddress reports the preferred private network address for one or more entities. Machines and units are supported.

entities : typing.Sequence[~Entity] Returns -> SSHAddressResults

coroutine Proxy()

Proxy returns whether SSH connections should be proxied through the controller hosts for the model associated with the API connection.

Returns -> SSHProxyResult

coroutine PublicAddress(entities=None)

PublicAddress reports the preferred public network address for one or more entities. Machines and units are supported.

entities : typing.Sequence[~Entity] Returns -> SSHAddressResults

coroutine PublicKeys(entities=None)

PublicKeys returns the public SSH hosts for one or more entities. Machines and units are supported.

entities : typing.Sequence[~Entity] Returns -> SSHPublicKeysResults

name = 'SSHClient'

version = 4

juju.client._client5 module

class juju.client._client5.ApplicationOffersFacade

Bases: Type

coroutine ApplicationOffers(bakery_version=None, offer_urls=None)

ApplicationOffers gets details about remote applications that match given URLs.

bakery_version : int offer_urls : typing.Sequence[str] Returns -> ApplicationOffersResults

coroutine DestroyOffers(force=None, offer_urls=None)

DestroyOffers removes the offers specified by the given URLs, forcing if necessary.

force : bool offer_urls : typing.Sequence[str] Returns -> ErrorResults

coroutine FindApplicationOffers(filters=None)

FindApplicationOffers gets details about remote applications that match given filter.

filters : typing.Sequence[~OfferFilter] Returns -> QueryApplicationOffersResultsV5

coroutine GetConsumeDetails(offer_urls=None, user_tag=None)

GetConsumeDetails returns the details necessary to pass to another model to allow the specified args user to consume the offers represented by the args URLs.

offer_urls : OfferURLs user_tag : str Returns -> ConsumeOfferDetailsResults

coroutine ListApplicationOffers(filters=None)

ListApplicationOffers gets deployed details about application offers that match given filter. The results contain details about the deployed applications such as connection count.

filters : typing.Sequence[~OfferFilter] Returns -> QueryApplicationOffersResultsV5

coroutine ModifyOfferAccess(changes=None)

ModifyOfferAccess changes the application offer access granted to users.

changes : typing.Sequence[~ModifyOfferAccess] Returns -> ErrorResults

coroutine Offer(offers=None)

Offer makes application endpoints available for consumption at a specified URL.

offers : typing.Sequence[~AddApplicationOffer] Returns -> ErrorResults

coroutine RemoteApplicationInfo(bakery_version=None, offer_urls=None)

RemoteApplicationInfo returns information about the requested remote application. This call currently has no client side API, only there for the Dashboard at this stage.

bakery_version : int offer_urls : typing.Sequence[str] Returns -> RemoteApplicationInfoResults

name = 'ApplicationOffers'

version = 5

class juju.client._client5.SubnetsFacade

Bases: Type

coroutine AllZones()

AllZones returns all availability zones known to Juju. If a zone is unusable, unavailable, or deprecated the Available field will be false.

Returns -> ZoneResults

coroutine ListSubnets(space_tag=None, zone=None)

ListSubnets returns the matching subnets after applying optional filters.

space_tag : str zone : str Returns -> ListSubnetsResults

coroutine SubnetsByCIDR(cidrs=None)

SubnetsByCIDR returns the collection of subnets matching each CIDR in the input.

cidrs : typing.Sequence[str] Returns -> SubnetsResults

name = 'Subnets'

version = 5

juju.client.codegen module

class juju.client.codegen.Capture(default_factory=<class 'juju.client.codegen.CodeWriter'>, *args, **kwargs)

Bases: defaultdict

A collection of CodeWriter objects, together representing a Python module.

clear(name)

Reset one of the keys in this class, if it exists.

This is necessary, because we don’t worry about de-duplicating the schemas for each version of juju up front, and this gives us a way to sort of de-duplicate on the fly, by resetting a specific CodeWriter instance before we start to write a class into it.

class juju.client.codegen.CodeWriter(initial_value='', newline='\n')

Bases: StringIO

Blob of text that, when used in the context of facade.py, ends up holding the source code for a Python class and associated methods.

CLASS = 0

INDENT = '    '

METHOD = 1

write(msg, depth=0)

Write string to file.

Returns the number of characters written, which is always equal to the length of the string.

juju.client.connection module

class juju.client.connection.Connection

Bases: object

Usage:

# Connect to an arbitrary api server

client = await Connection.connect(

api_endpoint, model_uuid, username, password, cacert)

MAX_FRAME_SIZE = 67108864

Maximum size for a single frame, 64MB.

bakery_client: Any

coroutine clone()

Return a new Connection, connected to the same websocket endpoint as this one.

coroutine close(to_reconnect: bool = False)

classmethod coroutine connect(endpoint=None, uuid: str | None = None, username: str | None = None, password: str | None = None, cacert=None, bakery_client=None, max_frame_size: int | None = None, retries=3, retry_backoff=10, specified_facades: SpecifiedFacades | None = None, proxy=None, debug_log_conn=None, debug_log_params={}) → Self

Connect to the websocket.

If uuid is None, the connection will be to the controller. Otherwise it will be to the model.

Parameters:

• endpoint (str) – The hostname:port of the controller to connect to (or list of strings).

• uuid (str) – The model UUID to connect to (None for a controller-only connection).

• username (str) – The username for controller-local users (or None to use macaroon-based login.)

• password (str) – The password for controller-local users.

• cacert (str) – The CA certificate of the controller (PEM formatted).

• bakery_client (httpbakery.Client) – The macaroon bakery client to to use when performing macaroon-based login. Macaroon tokens acquired when logging will be saved to bakery_client.cookies. If this is None, a default bakery_client will be used.

• max_frame_size (int) – The maximum websocket frame size to allow.

• retries (int) – When connecting or reconnecting, and all endpoints fail, how many times to retry the connection before giving up.

• retry_backoff (int) – Number of seconds to increase the wait between connection retry attempts (a backoff of 10 with 3 retries would wait 10s, 20s, and 30s).

• specified_facades – (deprecated) define a series of facade versions you wish to override to prevent using the conservative client pinning with in the client.

• debug_log_conn (TextIOWrapper) – target if this is a debug log connection

• debug_log_params (dict) – filtering parameters for the debug-log output

connect_params()

Return a dict of parameters suitable for passing to Connection.connect that can be used to make a new connection to the same controller (and model if specified).

coroutine controller()

Return a Connection to the controller at self.endpoint

debug_log_filter_write(result)

endpoints: list[tuple[str, str]] | None

facades: dict[str, int]

https_connection() → tuple[http.client.HTTPSConnection, dict[str, str], str]

Return an https connection to this Connection’s endpoint.

Returns a 3-tuple containing:

1. The :class:`HTTPSConnection` instance
2. Dictionary of auth headers to be used with the connection
3. The root url path (str) to be used for requests.

is_debug_log_connection: bool

property is_open

property is_using_old_client

coroutine login()

max_frame_size: int

messages: IdQueue

monitor: Monitor

name: str

password: str | None

proxy: Any

coroutine reconnect()

Force a reconnection.

coroutine rpc(msg: dict[str, Any], encoder: json.JSONEncoder | None = None) → dict[str, _Json]

Make an RPC to the API. The message is encoded as JSON using the given encoder if any. :param msg: Parameters for the call (will be encoded as JSON). :param encoder: Encoder to be used when encoding the message. :return: The result of the call. :raises JujuAPIError: When there’s an error returned. :raises JujuError:

property username: str | None

usertag: str | None

uuid: str | None

property ws

class juju.client.connection.Monitor(connection: Connection)

Bases: object

Monitor helper class for our Connection class.

Contains a reference to an instantiated Connection, along with a reference to the Connection.receiver Future. Upon inspection of these objects, this class determines whether the connection is in an ‘error’, ‘connected’ or ‘disconnected’ state.

Use this class to stay up to date on the health of a connection, and take appropriate action if the connection errors out due to network issues or other unexpected circumstances.

CONNECTED = 'connected'

DISCONNECTED = 'disconnected'

DISCONNECTING = 'disconnecting'

ERROR = 'error'

property status

Determine the status of the connection and receiver, and return ERROR, CONNECTED, or DISCONNECTED as appropriate.

For simplicity, we only consider ourselves to be connected after the Connection class has setup a receiver task. This only happens after the websocket is open, and the connection isn’t usable until that receiver has been started.

juju.client.facade module

class juju.client.facade.Args(schema, defs)

Bases: list

as_kwargs()

as_validation()

as_validation returns a series of validation statements for every item in the the Args.

do_explode(kind)

get_doc()

py_to_schema_mapping()

schema_to_py_mapping()

typed()

class juju.client.facade.KindRegistry

Bases: dict

get_obj(name, version=None)

lookup(name, version=None)

If version is omitted, max version is used

register(name, version, obj)

juju.client.facade.ReturnMapping(cls)

class juju.client.facade.Schema(schema)

Bases: dict

build_array(obj)

build_definitions()

build_object(node, name=None)

reference_name(ref)

class juju.client.facade.Type

Bases: object

connect(connection)

classmethod from_json(data: juju.client.facade.Type | str | dict[str, Any] | list[Any]) → Optional[Self]

get(key, default=None)

coroutine rpc(msg: dict[str, _RichJson]) → _Json

serialize() → dict[str, _Json]

to_json() → str

class juju.client.facade.TypeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: JSONEncoder

default(obj: _RichJson) → _Json

Implement this method in a subclass such that it returns a serializable object for o, or calls the base implementation (to raise a TypeError).

For example, to support arbitrary iterators, you could implement default like this:

def default(self, o):
    try:
        iterable = iter(o)
    except TypeError:
        pass
    else:
        return list(iterable)
    # Let the base class default method raise the TypeError
    return super().default(o)

class juju.client.facade.TypeRegistry(schema)

Bases: dict

get(name)

Return the value for key if key is in the dictionary, else default.

get_ref_type(ref)

obj_type(obj)

ref_type(obj)

juju.client.facade.booler(v)

juju.client.facade.build_facade(schema)

juju.client.facade.build_methods(cls, capture)

juju.client.facade.build_types(schema, capture)

juju.client.facade.build_validation(name, instance_type, instance_sub_type, ident=None)

juju.client.facade.build_watcher_methods(cls, capture)

juju.client.facade.generate_definitions(schemas)

juju.client.facade.generate_facades(schemas: dict[str, list[juju.client.facade.Schema]]) → dict[str, dict[int, juju.client.codegen.Capture]]

juju.client.facade.kind_to_py(kind)

juju.client.facade.load_schemas(options)

juju.client.facade.main()

juju.client.facade.make_factory(name)

juju.client.facade.make_func(cls, name, description, params, result, _async=True)

juju.client.facade.make_rpc_func(cls)

juju.client.facade.name_to_py(name)

juju.client.facade.retspec(schema, defs)

juju.client.facade.setup()

juju.client.facade.strcast(kind, keep_builtins=False)

juju.client.facade.var_type_to_py(kind)

juju.client.facade.write_client(captures, options)

Write the TypeFactory classes to _client.py, along with some imports and tables so that we can look up versioned Facades.

juju.client.facade.write_definitions(captures, options)

Write auxiliary (non versioned) classes to _definitions.py The auxiliary classes currently get written redudantly into each capture object, so we can look in one of them – we just use the last one from the loop above.

juju.client.facade.write_facades(captures, options)

Write the Facades to the appropriate _client<version>.py

juju.client.overrides module

class juju.client.overrides.Binary(number=None, series=None, arch=None, **unknown_fields)

Bases: Binary

Represent a semver string with additional series and arch info.

Because it is not standard JSON, the typical from_json parsing fails and the parsing must be handled specially.

See https://github.com/juju/version for more info.

binaryPat = re.compile('^(\\d{1,9})\\.(\\d{1,9})(?:\\.|-([a-z]+))(\\d{1,9})(\\.\\d{1,9})?-([^-]+)-([^-]+)$')

classmethod from_json(data)

serialize()

to_json()

class juju.client.overrides.ConfigValue(source=None, value=None, **unknown_fields)

Bases: ConfigValue

class juju.client.overrides.Delta(deltas: tuple[str, str, dict[str, Any]])

Bases: Type

A single websocket delta.

Variables:

• entity (str) – The entity name, e.g. ‘unit’, ‘application’

• type (str) – The delta type, e.g. ‘add’, ‘change’, ‘remove’

• data (dict) – The raw delta data

NOTE: The ‘data’ variable above is being incorrectly cross-linked by a Sphinx bug: https://github.com/sphinx-doc/sphinx/issues/2549

classmethod from_json(data)

class juju.client.overrides.Number(major=None, minor=None, patch=None, tag=None, build=None, **unknown_fields)

Bases: Number

Represent a semver string.

Because it is not standard JSON, the typical from_json parsing fails and the parsing must be handled specially.

See https://github.com/juju/version for more info.

classmethod from_json(data)

numberPat = re.compile('^(\\d{1,9})\\.(\\d{1,9})(?:\\.|-([a-z]+))(\\d{1,9})(\\.\\d{1,9})?$')

serialize()

to_json()

class juju.client.overrides.Resource(charmresource=None, application=None, id_=None, pending_id=None, timestamp=None, username=None, name=None, origin=None, **unknown_fields)

Bases: Type

juju.client.runner module

class juju.client.runner.AsyncRunner

Bases: object

class juju.client.runner.ThreadedRunner

Bases: object

Module contents

Juju client.