Skip to content

get_sol_function_package_descriptor async

get_sol_function_package_descriptor(
    vnf_pkg_id: VnfPkgId,
    accept: DescriptorContentType,
    *,
    config_overrides: Optional[AsynctnbClientConfig] = None,
) -> GetSolFunctionPackageDescriptorOutput

Gets a function package descriptor in a function package.

A function package descriptor is a .yaml file in a function package that uses the TOSCA standard to describe how the network function in the function package should run on your network.

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

Parameters:

  • vnf_pkg_id (VnfPkgId) –

    ID of the function package.

  • accept (DescriptorContentType) –

    Indicates which content types, expressed as MIME types, the client is able to understand.

Raises:

Examples:

Get the descriptor of a function package

>>> await client.get_sol_function_package_descriptor(accept='text/plain', vnf_pkg_id='fp-07aa863e53460a2a6')
Source code in docs_src/capo_tnb/_services/async_tnb.py
async def get_sol_function_package_descriptor(
    self,
    vnf_pkg_id: "capo_tnb.types.vnf_pkg_id.VnfPkgId",
    accept: "capo_tnb.types.descriptor_content_type.DescriptorContentType",
    *,
    config_overrides: Optional[AsynctnbClientConfig] = None,
) -> "capo_tnb.types.get_sol_function_package_descriptor_output.GetSolFunctionPackageDescriptorOutput":
    """<p>Gets a function package descriptor in a function package.</p> <p>A function package descriptor is a .yaml file in a function package that uses the TOSCA standard to describe how the network function in the function package should run on your network.</p> <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.</p>

    Args:
        vnf_pkg_id: <p>ID of the function package.</p>
        accept: <p>Indicates which content types, expressed as MIME types, the client is able to understand.</p>

    Raises:
        capo_tnb.errors.access_denied_exception.AccessDeniedException: <p>Insufficient permissions to make request.</p>
        capo_tnb.errors.internal_server_exception.InternalServerException: <p>Unexpected error occurred. Problem on the server.</p>
        capo_tnb.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource that doesn't exist.</p>
        capo_tnb.errors.throttling_exception.ThrottlingException: <p>Exception caused by throttling.</p>
        capo_tnb.errors.validation_exception.ValidationException: <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
        capo_tnb.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get the descriptor of a function package

        >>> await client.get_sol_function_package_descriptor(accept='text/plain', vnf_pkg_id='fp-07aa863e53460a2a6')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_tnb.types.get_sol_function_package_descriptor_input.GetSolFunctionPackageDescriptorInput]",
    ) -> AsyncOperationResponse[
        "capo_tnb.types.get_sol_function_package_descriptor_output.GetSolFunctionPackageDescriptorOutput"
    ]:
        import capo_tnb._operations.tnb.get_sol_function_package_descriptor

        (
            output,
            http_response,
        ) = await capo_tnb._operations.tnb.get_sol_function_package_descriptor.async_get_sol_function_package_descriptor(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSolFunctionPackageDescriptor")
    )
    input_: capo_tnb.types.get_sol_function_package_descriptor_input.GetSolFunctionPackageDescriptorInput = {
        "vnf_pkg_id": vnf_pkg_id,
        "accept": accept,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output