onapsdk package

Subpackages

• onapsdk.aai package
  • Subpackages
    • onapsdk.aai.business package
      • Submodules
      • onapsdk.aai.business.customer module
      • onapsdk.aai.business.instance module
      • onapsdk.aai.business.line_of_business module
      • onapsdk.aai.business.network module
      • onapsdk.aai.business.owning_entity module
      • onapsdk.aai.business.platform module
      • onapsdk.aai.business.pnf module
      • onapsdk.aai.business.project module
      • onapsdk.aai.business.service module
      • onapsdk.aai.business.sp_partner module
      • onapsdk.aai.business.vf_module module
      • onapsdk.aai.business.vnf module
      • Module contents
    • onapsdk.aai.cloud_infrastructure package
      • Submodules
      • onapsdk.aai.cloud_infrastructure.cloud_region module
      • onapsdk.aai.cloud_infrastructure.complex module
      • onapsdk.aai.cloud_infrastructure.tenant module
      • Module contents
  • Submodules
  • onapsdk.aai.aai_element module
  • onapsdk.aai.bulk module
  • onapsdk.aai.service_design_and_creation module
  • Module contents
• onapsdk.cds package
  • Submodules
  • onapsdk.cds.blueprint module
  • onapsdk.cds.blueprint_model module
  • onapsdk.cds.blueprint_processor module
  • onapsdk.cds.cds_element module
  • onapsdk.cds.data_dictionary module
  • Module contents
• onapsdk.clamp package
  • Submodules
  • onapsdk.clamp.clamp_element module
  • onapsdk.clamp.loop_instance module
  • Module contents
• onapsdk.configuration package
  • Submodules
  • onapsdk.configuration.global_settings module
  • onapsdk.configuration.loader module
    • SettingsLoader
      • SettingsLoader.filter_and_set()
  • Module contents
• onapsdk.dmaap package
  • Submodules
  • onapsdk.dmaap.dmaap module
  • onapsdk.dmaap.dmaap_service module
  • Module contents
• onapsdk.msb package
  • Subpackages
    • onapsdk.msb.k8s package
      • Submodules
      • onapsdk.msb.k8s.connectivity_info module
      • onapsdk.msb.k8s.definition module
      • onapsdk.msb.k8s.instance module
      • Module contents
  • Submodules
  • onapsdk.msb.esr module
  • onapsdk.msb.msb_service module
  • onapsdk.msb.multicloud module
  • Module contents
• onapsdk.nbi package
  • Submodules
  • onapsdk.nbi.nbi module
  • Module contents
• onapsdk.sdc package
  • Submodules
  • onapsdk.sdc.category_management module
  • onapsdk.sdc.component module
  • onapsdk.sdc.pnf module
  • onapsdk.sdc.properties module
  • onapsdk.sdc.sdc_element module
  • onapsdk.sdc.sdc_resource module
  • onapsdk.sdc.service module
  • onapsdk.sdc.vendor module
  • onapsdk.sdc.vf module
  • onapsdk.sdc.vl module
  • onapsdk.sdc.vsp module
  • Module contents
• onapsdk.sdnc package
  • Submodules
  • onapsdk.sdnc.preload module
  • onapsdk.sdnc.sdnc_element module
  • Module contents
• onapsdk.so package
  • Submodules
  • onapsdk.so.deletion module
  • onapsdk.so.instantiation module
  • onapsdk.so.so_db_adapter module
  • onapsdk.so.so_element module
  • Module contents
• onapsdk.utils package
  • Submodules
  • onapsdk.utils.configuration module
    • components_needing_distribution()
  • onapsdk.utils.headers_creator module
    • headers_aai_creator()
    • headers_clamp_creator()
    • headers_msb_creator()
    • headers_sdc_artifact_upload()
    • headers_sdc_creator()
    • headers_sdc_generic()
    • headers_sdc_governor()
    • headers_sdc_operator()
    • headers_sdc_tester()
    • headers_sdnc_creator()
    • headers_so_catelog_db_creator()
    • headers_so_creator()
  • onapsdk.utils.jinja module
    • jinja_env()
  • onapsdk.utils.mixins module
    • WaitForFinishMixin
      • WaitForFinishMixin.WAIT_FOR_SLEEP_TIME
      • WaitForFinishMixin.completed
      • WaitForFinishMixin.finished
      • WaitForFinishMixin.wait_for_finish()
  • onapsdk.utils.tosca_file_handler module
    • get_modules_list_from_tosca_file()
    • get_parameter_from_yaml()
    • get_vf_list_from_tosca_file()
    • random_string_generator()
  • Module contents
    • get_zulu_time_isoformat()
    • load_json_file()
• onapsdk.ves package
  • Submodules
  • onapsdk.ves.ves module
  • onapsdk.ves.ves_service module
  • Module contents
• onapsdk.vid package
  • Submodules
  • onapsdk.vid.vid module
  • Module contents

Submodules

onapsdk.constants module

Constant package.

onapsdk.exceptions module

ONAP Exception module.

exception onapsdk.exceptions.APIError(message=None, response_status_code=None, response_text=None)

Bases: RequestError

API error occured.

property response_status_code: int

Response status code property.

Returns:

Response status code. If not set, returns 0

Return type:

int

property response_text: str | None

Response status code property.

Returns:

Response status code. If not set, returns 0

Return type:

int

exception onapsdk.exceptions.ConnectionFailed

Bases: RequestError

Unable to connect.

exception onapsdk.exceptions.FileError

Bases: ValidationError

Reading in a file failed.

exception onapsdk.exceptions.InvalidResponse

Bases: RequestError

Unable to decode response.

exception onapsdk.exceptions.ModuleError

Bases: SDKException

Unable to import module.

exception onapsdk.exceptions.NoGuiError

Bases: SDKException

No GUI available for this component.

exception onapsdk.exceptions.ParameterError

Bases: SDKException

Parameter does not satisfy requirements.

exception onapsdk.exceptions.RelationshipNotFound(message=None, response_status_code=None, response_text=None)

Bases: ResourceNotFound

Required relationship is missing.

exception onapsdk.exceptions.RequestError

Bases: SDKException

Request error occured.

exception onapsdk.exceptions.ResourceNotFound(message=None, response_status_code=None, response_text=None)

Bases: APIError

Requested resource does not exist.

exception onapsdk.exceptions.SDKException

Bases: Exception

Generic exception for ONAP SDK.

exception onapsdk.exceptions.SettingsError

Bases: SDKException

Some settings are wrong.

exception onapsdk.exceptions.StatusError

Bases: SDKException

Invalid status.

exception onapsdk.exceptions.ValidationError

Bases: SDKException

Data validation failed.

onapsdk.onap_service module

onapsdk.version module

Version module.

Module contents

ONAP SDK master package.