heat.engine.clients package

Subpackages

• heat.engine.clients.os package
  • Subpackages
    • heat.engine.clients.os.keystone package
      • Submodules
      • Module contents
    • heat.engine.clients.os.neutron package
      • Submodules
      • Module contents
  • Submodules
    • heat.engine.clients.os.aodh module
      • AodhClientPlugin
    • heat.engine.clients.os.barbican module
      • BarbicanClientPlugin
      • ContainerConstraint
      • SecretConstraint
    • heat.engine.clients.os.blazar module
      • BlazarBaseConstraint
      • BlazarClientPlugin
      • ReservationConstraint
    • heat.engine.clients.os.cinder module
      • BaseCinderConstraint
      • CinderClientPlugin
      • QoSSpecsConstraint
      • VolumeBackupConstraint
      • VolumeConstraint
      • VolumeSnapshotConstraint
      • VolumeTypeConstraint
    • heat.engine.clients.os.designate module
      • DesignateClientPlugin
      • DesignateZoneConstraint
    • heat.engine.clients.os.glance module
      • GlanceClientPlugin
      • ImageConstraint
    • heat.engine.clients.os.heat_plugin module
      • HeatClientPlugin
    • heat.engine.clients.os.ironic module
      • IronicClientPlugin
      • NodeConstraint
      • PortGroupConstraint
    • heat.engine.clients.os.magnum module
      • ClusterTemplateConstraint
      • MagnumClientPlugin
    • heat.engine.clients.os.manila module
      • ManilaClientPlugin
      • ManilaShareBaseConstraint
      • ManilaShareNetworkConstraint
      • ManilaShareSnapshotConstraint
      • ManilaShareTypeConstraint
    • heat.engine.clients.os.mistral module
      • MistralClientPlugin
      • WorkflowConstraint
    • heat.engine.clients.os.monasca module
      • MonascaClientPlugin
      • MonascaNotificationConstraint
    • heat.engine.clients.os.nova module
      • FlavorConstraint
      • HostConstraint
      • KeypairConstraint
      • NovaBaseConstraint
      • NovaClientPlugin
      • ServerConstraint
    • heat.engine.clients.os.octavia module
      • FlavorConstraint
      • FlavorProfileConstraint
      • L7PolicyConstraint
      • ListenerConstraint
      • LoadbalancerConstraint
      • OctaviaClientPlugin
      • OctaviaConstraint
      • PoolConstraint
    • heat.engine.clients.os.openstacksdk module
      • OpenStackSDKPlugin
      • SegmentConstraint
    • heat.engine.clients.os.swift module
      • SwiftClientPlugin
    • heat.engine.clients.os.trove module
      • FlavorConstraint
      • TroveClientPlugin
    • heat.engine.clients.os.vitrage module
      • VitrageClientPlugin
    • heat.engine.clients.os.zaqar module
      • QueueConstraint
      • ZaqarClientPlugin
      • ZaqarEventSink
    • heat.engine.clients.os.zun module
      • ZunClientPlugin
  • Module contents
    • ExtensionMixin
      • ExtensionMixin.has_extension()

Submodules

• heat.engine.clients.client_exception module
  • EntityMatchNotFound
    • EntityMatchNotFound.msg_fmt
  • EntityUniqueMatchNotFound
    • EntityUniqueMatchNotFound.msg_fmt
  • InterfaceNotFound
    • InterfaceNotFound.msg_fmt
• heat.engine.clients.client_plugin module
  • ClientPlugin
    • ClientPlugin.client()
    • ClientPlugin.clients
    • ClientPlugin.context
    • ClientPlugin.default_version
    • ClientPlugin.does_endpoint_exist()
    • ClientPlugin.exceptions_module
    • ClientPlugin.ignore_conflict_and_not_found()
    • ClientPlugin.ignore_not_found()
    • ClientPlugin.is_client_exception()
    • ClientPlugin.is_conflict()
    • ClientPlugin.is_not_found()
    • ClientPlugin.is_over_limit()
    • ClientPlugin.service_types
    • ClientPlugin.supported_versions
    • ClientPlugin.url_for()
  • retry_if_connection_err()
  • retry_if_result_is_false()
• heat.engine.clients.default_client_plugin module
  • DefaultClientPlugin
• heat.engine.clients.microversion_mixin module
  • MicroversionMixin
    • MicroversionMixin.client()
    • MicroversionMixin.get_max_microversion()
    • MicroversionMixin.is_version_supported()
• heat.engine.clients.progress module
  • ContainerUpdateProgress
  • PoolDeleteProgress
  • ServerCreateProgress
  • ServerDeleteProgress
  • ServerUpdateProgress
  • UpdateProgressBase
  • VolumeAttachProgress
  • VolumeBackupRestoreProgress
  • VolumeDeleteProgress
  • VolumeDetachProgress
  • VolumeResizeProgress
  • VolumeUpdateAccessModeProgress

Module contents

class heat.engine.clients.ClientBackend(context)

Bases: object

Class for delaying choosing the backend client module.

Delay choosing the backend client module until the client’s class needs to be initialized.

heat.engine.clients.Clients

alias of ClientBackend

class heat.engine.clients.OpenStackClients(context)

Bases: object

Convenience class to create and cache client instances.

client(name, version=None)

client_plugin(name)

property context

heat.engine.clients.has_client(name)

heat.engine.clients.initialise()

heat.engine.clients.list_opts()