in azext_iot/sdk/digitaltwins/dataplane/operations/digital_twin_models_operations.py [0:0]
def list(
self, dependencies_for=None, include_model_definition=False, digital_twin_models_list_options=None, custom_headers=None, raw=False, **operation_config):
"""Retrieves model metadata and, optionally, model definitions.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The model id is invalid.
* LimitExceeded - The maximum number of model ids allowed in
'dependenciesFor' has been reached.
* 404 Not Found
* ModelNotFound - The model was not found.
:param dependencies_for: If specified, only return the set of the
specified models along with their dependencies. If omitted, all models
are retrieved.
:type dependencies_for: list[str]
:param include_model_definition: When true the model definition will
be returned as part of the result.
:type include_model_definition: bool
:param digital_twin_models_list_options: Additional parameters for the
operation
:type digital_twin_models_list_options:
~dataplane.models.DigitalTwinModelsListOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: An iterator like instance of DigitalTwinsModelData
:rtype:
~dataplane.models.DigitalTwinsModelDataPaged[~dataplane.models.DigitalTwinsModelData]
:raises:
:class:`ErrorResponseException<dataplane.models.ErrorResponseException>`
"""
max_items_per_page = None
if digital_twin_models_list_options is not None:
max_items_per_page = digital_twin_models_list_options.max_items_per_page
traceparent = None
if digital_twin_models_list_options is not None:
traceparent = digital_twin_models_list_options.traceparent
tracestate = None
if digital_twin_models_list_options is not None:
tracestate = digital_twin_models_list_options.tracestate
def internal_paging(next_link=None, raw=False):
if not next_link:
# Construct URL
url = self.list.metadata['url']
# Construct parameters
query_parameters = {}
if dependencies_for is not None:
# @vilit - the div should be "&dependenciesFor=" not ","
query_parameters['dependenciesFor'] = self._serialize.query("dependencies_for", dependencies_for, '[str]', div='&dependenciesFor=')
if include_model_definition is not None:
query_parameters['includeModelDefinition'] = self._serialize.query("include_model_definition", include_model_definition, 'bool')
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str', min_length=1)
else:
url = next_link
query_parameters = {}
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['x-ms-client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if max_items_per_page is not None:
header_parameters['max-items-per-page'] = self._serialize.header("max_items_per_page", max_items_per_page, 'int')
if traceparent is not None:
header_parameters['traceparent'] = self._serialize.header("traceparent", traceparent, 'str')
if tracestate is not None:
header_parameters['tracestate'] = self._serialize.header("tracestate", tracestate, 'str')
# Construct and send request
request = self._client.get(url, query_parameters)
response = self._client.send(
request, header_parameters, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.ErrorResponseException(self._deserialize, response)
return response
# Deserialize response
deserialized = models.DigitalTwinsModelDataPaged(internal_paging, self._deserialize.dependencies)
if raw:
header_dict = {}
client_raw_response = models.DigitalTwinsModelDataPaged(internal_paging, self._deserialize.dependencies, header_dict)
return client_raw_response
return deserialized