azure.maps.route.models package¶

class azure.maps.route.models.AlternativeRouteType(value)[source]¶

AlternativeRouteType.

ANY_ROUTE = 'anyRoute'¶: Allow any alternative route to be returned irrespective of how it compares to the reference route in terms of optimality.

BETTER_ROUTE = 'betterRoute'¶: Return an alternative route only if it is better than the reference route according to the given planning criteria.

class azure.maps.route.models.BatchResultSummary(**kwargs)[source]¶

Summary of the results for the batch request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

successful_requests (int) – Number of successful requests in the batch.
total_requests (int) – Total number of requests in the batch.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.BoundingBox(west: float = 0.0, south: float = 0.0, east: float = 0.0, north: float = 0.0)[source]¶

Represents information about the coordinate range

Keyword Arguments

west (float) – The westmost value of coordinates.
south (float) – The southmost value of coordinates.
east (float) – The eastmost value of coordinates.
north (float) – The northmost value of coordinates.

Create new instance of BoundingBox(west, south, east, north)

count(value, /)¶: Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)¶

Return first index of value.

Raises ValueError if the value is not present.

east: float¶: Alias for field number 2

north: float¶: Alias for field number 3

south: float¶: Alias for field number 1

west: float¶: Alias for field number 0

class azure.maps.route.models.ComputeTravelTime(value)[source]¶

ComputeTravelTime.

ALL = 'all'¶: Computes travel times for all types of traffic information and specifies all results in the fields noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds and liveTrafficIncidentsTravelTimeInSeconds being included in the summaries in the route response.

NONE = 'none'¶: Does not compute additional travel times.

class azure.maps.route.models.GeoJsonFeature(*, geometry: azure.maps.route.models._models.GeoJsonObject, properties: Optional[object] = None, feature_type: Optional[str] = None, **kwargs)[source]¶

A valid GeoJSON Feature object type. Please refer to RFC 7946 for details.

All required parameters must be populated in order to send to Azure.

Parameters

geometry (GeoJsonObject) –
Required. A valid GeoJSON object. Please refer to RFC 7946 for details.
properties (object) – Properties can contain any additional metadata about the Feature. Value can be any JSON object or a JSON null value.
type (str or GeoJsonObjectType) – Required. Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.Constant filled by server. Possible values include: “Point”, “MultiPoint”, “LineString”, “MultiLineString”, “Polygon”, “MultiPolygon”, “GeometryCollection”, “Feature”, “FeatureCollection”.

Keyword Arguments

feature_type (str) – The type of the feature. The value depends on the data model the current feature is part of. Some data models may have an empty value.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

validate()¶

Validate this model recursively and return a list of ValidationError.

Returns: A list of validation error
Return type: list

class azure.maps.route.models.GeoJsonFeatureCollection(*, features: List[azure.maps.route.models._models.GeoJsonFeature], **kwargs)[source]¶

A valid GeoJSON FeatureCollection object type. Please refer to RFC 7946 for details.

All required parameters must be populated in order to send to Azure.

Parameters

features (list[GeoJsonFeature]) – Required. Contains a list of valid GeoJSON Feature objects.
type (str or GeoJsonObjectType) – Required. Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.Constant filled by server. Possible values include: “Point”, “MultiPoint”, “LineString”, “MultiLineString”, “Polygon”, “MultiPolygon”, “GeometryCollection”, “Feature”, “FeatureCollection”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

validate()¶

Validate this model recursively and return a list of ValidationError.

Returns: A list of validation error
Return type: list

class azure.maps.route.models.GeoJsonFeatureCollectionData(*, features: List[_models.GeoJsonFeature], **kwargs)[source]¶

GeoJsonFeatureCollectionData.

All required parameters must be populated in order to send to Azure.

Variables: features (list[GeoJsonFeature]) – Contains a list of valid GeoJSON Feature objects. Required.
Keyword Arguments: features (list[GeoJsonFeature]) – Contains a list of valid GeoJSON Feature objects. Required.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.GeoJsonFeatureData(*, geometry: azure.maps.route.models._models.GeoJsonObject, properties: Optional[object] = None, feature_type: Optional[str] = None, **kwargs)[source]¶

GeoJsonFeatureData.

All required parameters must be populated in order to send to Azure.

Parameters

geometry (GeoJsonObject) –
Required. A valid GeoJSON object. Please refer to RFC 7946 for details.
properties (object) – Properties can contain any additional metadata about the Feature. Value can be any JSON object or a JSON null value.
feature_type (str) – The type of the feature. The value depends on the data model the current feature is part of. Some data models may have an empty value.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

validate()¶

Validate this model recursively and return a list of ValidationError.

Returns: A list of validation error
Return type: list

class azure.maps.route.models.GeoJsonGeometry(**kwargs)[source]¶

A valid GeoJSON geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to RFC 7946 for details.

All required parameters must be populated in order to send to Azure.

Parameters: type (str or GeoJsonObjectType) – Required. Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.Constant filled by server. Possible values include: “Point”, “MultiPoint”, “LineString”, “MultiLineString”, “Polygon”, “MultiPolygon”, “GeometryCollection”, “Feature”, “FeatureCollection”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

validate()¶

Validate this model recursively and return a list of ValidationError.

Returns: A list of validation error
Return type: list

class azure.maps.route.models.GeoJsonGeometryCollection(*, geometries: List[azure.maps.route.models._models.GeoJsonObject], **kwargs)[source]¶

A valid GeoJSON GeometryCollection object type. Please refer to RFC 7946 for details.

All required parameters must be populated in order to send to Azure.

Parameters

geometries (list[GeoJsonObject]) – Required. Contains a list of valid GeoJSON geometry objects. Note that coordinates in GeoJSON are in x, y order (longitude, latitude).
type (str or GeoJsonObjectType) – Required. Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.Constant filled by server. Possible values include: “Point”, “MultiPoint”, “LineString”, “MultiLineString”, “Polygon”, “MultiPolygon”, “GeometryCollection”, “Feature”, “FeatureCollection”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

validate()¶

Validate this model recursively and return a list of ValidationError.

Returns: A list of validation error
Return type: list

class azure.maps.route.models.GeoJsonGeometryCollectionData(*, geometries: List[_models.GeoJsonGeometry], **kwargs)[source]¶

GeoJsonGeometryCollectionData.

All required parameters must be populated in order to send to Azure.

Variables: geometries (list[GeoJsonGeometry]) – Contains a list of valid GeoJSON geometry objects. Note that coordinates in GeoJSON are in x, y order (longitude, latitude). Required.
Keyword Arguments: geometries (list[GeoJsonGeometry]) – Contains a list of valid GeoJSON geometry objects. Note that coordinates in GeoJSON are in x, y order (longitude, latitude). Required.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.GeoJsonMultiLineString(*, coordinates: List[List[azure.maps.route.models._models.LatLon]], **kwargs)[source]¶

A valid GeoJSON MultiLineString geometry type. Please refer to RFC 7946 for details.

All required parameters must be populated in order to send to Azure.

Parameters

coordinates (list[list[LatLon]]) – Required. Coordinates for the GeoJson MultiLineString geometry.
type (str or GeoJsonObjectType) – Required. Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.Constant filled by server. Possible values include: “Point”, “MultiPoint”, “LineString”, “MultiLineString”, “Polygon”, “MultiPolygon”, “GeometryCollection”, “Feature”, “FeatureCollection”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

validate()¶

Validate this model recursively and return a list of ValidationError.

Returns: A list of validation error
Return type: list

class azure.maps.route.models.GeoJsonMultiLineStringData(**kwargs)[source]¶

GeoJsonMultiLineStringData.

All required parameters must be populated in order to send to Azure.

Parameters: coordinates (list[list[list[LatLon]]]) – Required. Coordinates for the GeoJson MultiLineString geometry.

class azure.maps.route.models.GeoJsonMultiPoint(*, coordinates: List[azure.maps.route.models._models.LatLon], **kwargs)[source]¶

A valid GeoJSON MultiPoint geometry type. Please refer to RFC 7946 for details.

All required parameters must be populated in order to send to Azure.

Parameters

coordinates (list[LatLon]) – Required. Coordinates for the GeoJson MultiPoint geometry.
type (str or GeoJsonObjectType) – Required. Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.Constant filled by server. Possible values include: “Point”, “MultiPoint”, “LineString”, “MultiLineString”, “Polygon”, “MultiPolygon”, “GeometryCollection”, “Feature”, “FeatureCollection”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

validate()¶

Validate this model recursively and return a list of ValidationError.

Returns: A list of validation error
Return type: list

class azure.maps.route.models.GeoJsonMultiPointData(**kwargs)[source]¶

Data contained by a GeoJson MultiPoint.

All required parameters must be populated in order to send to Azure.

Parameters: coordinates (list[list[LatLon]]) – Required. Coordinates for the GeoJson MultiPoint geometry.

class azure.maps.route.models.GeoJsonMultiPolygon(*, coordinates: List[List[List[azure.maps.route.models._models.LatLon]]], **kwargs)[source]¶

A valid GeoJSON MultiPolygon object type. Please refer to RFC 7946 for details.

All required parameters must be populated in order to send to Azure.

Parameters

coordinates (list[list[list[LatLon]]]) – Required. Contains a list of valid GeoJSON Polygon objects. Note that coordinates in GeoJSON are in x, y order (longitude, latitude).
type (str or GeoJsonObjectType) – Required. Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.Constant filled by server. Possible values include: “Point”, “MultiPoint”, “LineString”, “MultiLineString”, “Polygon”, “MultiPolygon”, “GeometryCollection”, “Feature”, “FeatureCollection”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

validate()¶

Validate this model recursively and return a list of ValidationError.

Returns: A list of validation error
Return type: list

class azure.maps.route.models.GeoJsonMultiPolygonData(**kwargs)[source]¶

GeoJsonMultiPolygonData.

All required parameters must be populated in order to send to Azure.

Parameters: coordinates (list[list[list[list[LatLon]]]]) – Required. Contains a list of valid GeoJSON Polygon objects. Note that coordinates in GeoJSON are in x, y order (longitude, latitude).

class azure.maps.route.models.GeoJsonObject(_type: Optional[Union[str, azure.maps.route.models._models.GeoJsonObjectType]] = None, **kwargs)[source]¶

A valid GeoJSON object. Please refer to RFC 7946 for details.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: GeoJsonFeature, GeoJsonFeatureCollection, GeoJsonGeometry,

GeoJsonGeometryCollection, GeoJsonLineString, GeoJsonMultiLineString, GeoJsonMultiPoint, GeoJsonMultiPolygon, GeoJsonPoint, GeoJsonPolygon.

All required parameters must be populated in order to send to Azure.

Parameters: type (str or GeoJsonObjectType) – Required. Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.Constant filled by server. Possible values include: “Point”, “MultiPoint”, “LineString”, “MultiLineString”, “Polygon”, “MultiPolygon”, “GeometryCollection”, “Feature”, “FeatureCollection”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

validate()¶

Validate this model recursively and return a list of ValidationError.

Returns: A list of validation error
Return type: list

class azure.maps.route.models.GeoJsonObjectType(value)[source]¶

Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GEO_JSON_FEATURE = 'Feature'¶: GeoJSON Feature object.

GEO_JSON_FEATURE_COLLECTION = 'FeatureCollection'¶: GeoJSON FeatureCollection object.

GEO_JSON_GEOMETRY_COLLECTION = 'GeometryCollection'¶: GeoJSON GeometryCollection geometry.

GEO_JSON_LINE_STRING = 'LineString'¶: GeoJSON LineString geometry.

GEO_JSON_MULTI_LINE_STRING = 'MultiLineString'¶: GeoJSON MultiLineString geometry.

GEO_JSON_MULTI_POINT = 'MultiPoint'¶: GeoJSON MultiPoint geometry.

GEO_JSON_MULTI_POLYGON = 'MultiPolygon'¶: GeoJSON MultiPolygon geometry.

GEO_JSON_POINT = 'Point'¶: GeoJSON Point geometry.

GEO_JSON_POLYGON = 'Polygon'¶: GeoJSON Polygon geometry.

class azure.maps.route.models.GeoJsonPoint(*, coordinates: azure.maps.route.models._models.LatLon, **kwargs)[source]¶

A valid GeoJSON Point geometry type. Please refer to RFC 7946 for details.

All required parameters must be populated in order to send to Azure.

Parameters

coordinates (LatLon) –
Required. A Position is an array of numbers with two or more elements. The first two elements are longitude and latitude, precisely in that order. Altitude/Elevation is an optional third element. Please refer to RFC 7946 for details.
type (str or GeoJsonObjectType) – Required. Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.Constant filled by server. Possible values include: “Point”, “MultiPoint”, “LineString”, “MultiLineString”, “Polygon”, “MultiPolygon”, “GeometryCollection”, “Feature”, “FeatureCollection”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

validate()¶

Validate this model recursively and return a list of ValidationError.

Returns: A list of validation error
Return type: list

class azure.maps.route.models.GeoJsonPolygon(*, coordinates: List[List[azure.maps.route.models._models.LatLon]], **kwargs)[source]¶

A valid GeoJSON Polygon geometry type. Please refer to RFC 7946 for details.

All required parameters must be populated in order to send to Azure.

Parameters

coordinates (list[list[LatLon]]) – Required. Coordinates for the GeoJson Polygon geometry type.
type (str or GeoJsonObjectType) – Required. Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.Constant filled by server. Possible values include: “Point”, “MultiPoint”, “LineString”, “MultiLineString”, “Polygon”, “MultiPolygon”, “GeometryCollection”, “Feature”, “FeatureCollection”.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

validate()¶

Validate this model recursively and return a list of ValidationError.

Returns: A list of validation error
Return type: list

class azure.maps.route.models.GuidanceInstructionType(value)[source]¶

Type of the instruction, e.g., turn or change of road form.

DIRECTION_INFO = 'DIRECTION_INFO'¶: Direction information.

LOCATION_ARRIVAL = 'LOCATION_ARRIVAL'¶: Arrival location.

LOCATION_DEPARTURE = 'LOCATION_DEPARTURE'¶: Departure location.

LOCATION_WAYPOINT = 'LOCATION_WAYPOINT'¶: Way point location.

ROAD_CHANGE = 'ROAD_CHANGE'¶: Road Change.

TURN = 'TURN'¶: Turn.

class azure.maps.route.models.InclineLevel(value)[source]¶

InclineLevel.

HIGH = 'high'¶: high

LOW = 'low'¶: low

NORMAL = 'normal'¶: normal

class azure.maps.route.models.JunctionType(value)[source]¶

The type of the junction where the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout.

BIFURCATION = 'BIFURCATION'¶: bifurcation

REGULAR = 'REGULAR'¶: regular

ROUNDABOUT = 'ROUNDABOUT'¶: roundabout

class azure.maps.route.models.LatLon(lat: float = 0, lon: float = 0)[source]¶

Represents coordinate latitude and longitude

Keyword Arguments

lat (float) – The coordinate as latitude.
lon (float) – The coordinate as longitude.

Create new instance of LatLon(lat, lon)

count(value, /)¶: Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)¶

Return first index of value.

Raises ValueError if the value is not present.

lat: float¶: Alias for field number 0

lon: float¶: Alias for field number 1

class azure.maps.route.models.Route(**kwargs)[source]¶

Route.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

summary (RouteSummary) – Summary object.
legs (list[RouteLeg]) – Legs array.
sections (list[RouteSection]) – Sections array.
guidance (RouteGuidance) – Contains guidance related elements. This field is present only when guidance was requested and is available.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteAvoidType(value)[source]¶

RouteAvoidType.

ALREADY_USED_ROADS = 'alreadyUsedRoads'¶: Avoids using the same road multiple times. Most useful in conjunction with routeType=thrilling.

BORDER_CROSSINGS = 'borderCrossings'¶: Avoids border crossings in route calculation.

CARPOOLS = 'carpools'¶: Avoids routes that require the use of carpool (HOV/High Occupancy Vehicle) lanes.

FERRIES = 'ferries'¶: Avoids ferries

MOTORWAYS = 'motorways'¶: Avoids motorways

TOLL_ROADS = 'tollRoads'¶: Avoids toll roads.

UNPAVED_ROADS = 'unpavedRoads'¶: Avoids unpaved roads

class azure.maps.route.models.RouteDirections(*, report: Optional[_models.RouteReport] = None, **kwargs)[source]¶

This object is returned from a successful Route Directions call.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

format_version (str) – Format Version property.
routes (list[Route]) – Routes array.
optimized_waypoints (list[RouteOptimizedWaypoint]) –
Optimized sequence of waypoints. It shows the index from the user provided waypoint sequence for the original and optimized list. For instance, a response:
```
<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>
```
means that the original sequence is [0, 1, 2] and optimized sequence is [1, 2, 0]. Since the index starts by 0 the original is “first, second, third” while the optimized is “second, third, first”.
report (RouteReport) – Reports the effective settings used in the current call.

Keyword Arguments

report (RouteReport) – Reports the effective settings used in the current call.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteDirectionsBatchItem(**kwargs)[source]¶

An item returned from Route Directions Batch service call.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: result (RouteDirectionsBatchItemResult) – The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise.

class azure.maps.route.models.RouteDirectionsBatchItemResult(*, error: Optional[azure.maps.route._generated.models._models.ErrorDetail] = None, report: Optional[azure.maps.route._generated.models._models.RouteReport] = None, **kwargs)[source]¶

The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

error (ErrorDetail) – The error object.
format_version (str) – Format Version property.
routes (list[Route]) – Routes array.
optimized_waypoints (list[RouteOptimizedWaypoint]) –
Optimized sequence of waypoints. It shows the index from the user provided waypoint sequence for the original and optimized list. For instance, a response:
```
<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>
```
means that the original sequence is [0, 1, 2] and optimized sequence is [1, 2, 0]. Since the index starts by 0 the original is “first, second, third” while the optimized is “second, third, first”.
report (RouteReport) – Reports the effective settings used in the current call.

Keyword Arguments

error (ErrorDetail) – The error object.
report (RouteReport) – Reports the effective settings used in the current call.

class azure.maps.route.models.RouteDirectionsBatchResult(**kwargs)[source]¶

This object is returned from a successful Route Directions Batch service call.

Variables are only populated by the server, and will be ignored when sending a request.

Keyword Arguments

summary (BatchResultSummary) – Summary of the results for the batch request.
items (list[RouteDirectionsBatchItem]) – Array containing the batch results.

class azure.maps.route.models.RouteGuidance(**kwargs)[source]¶

Contains guidance related elements. This field is present only when guidance was requested and is available.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

instructions (list[RouteInstruction]) – A list of instructions describing maneuvers.
instruction_groups (list[RouteInstructionGroup]) – Groups a sequence of instruction elements which are related to each other.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteInstructionsType(value)[source]¶

RouteInstructionsType.

CODED = 'coded'¶: Returns raw instruction data without human-readable messages.

TAGGED = 'tagged'¶

Returns raw instruction data with tagged human-readable messages to permit formatting. A human-readable message is built up from repeatable identified elements. These are tagged to allow client applications to format them correctly. The following message components are tagged when instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Example of tagged ‘Turn left’ message:

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>

TEXT = 'text'¶: Returns raw instructions data with human-readable messages in plain text.

class azure.maps.route.models.RouteLeg(**kwargs)[source]¶

A description of a part of a route, comprised of a list of points. Each additional waypoint provided in the request will result in an additional leg in the returned route.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

summary (RouteLegSummary) – Summary object for route section.
points (list[LatLon]) – Points array.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteLegSummary(**kwargs)[source]¶

Summary object for route section.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

length_in_meters (int) – Length In Meters property.
travel_time_in_seconds (int) – Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data.
traffic_delay_in_seconds (int) – Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added.
departure_time (datetime) – The estimated departure time for the route or leg.
arrival_time (datetime) – The estimated arrival time for the route or leg.
no_traffic_travel_time_in_seconds (int) – Estimated travel time calculated as if there are no delays on the route due to traffic conditions (e.g. congestion). Included only if computeTravelTimeFor = all is used in the query.
historic_traffic_travel_time_in_seconds (int) – Estimated travel time calculated using time-dependent historic traffic data. Included only if computeTravelTimeFor = all is used in the query.
live_traffic_incidents_travel_time_in_seconds (int) – Estimated travel time calculated using real-time speed data. Included only if computeTravelTimeFor = all is used in the query.
fuel_consumption_in_liters (float) – Estimated fuel consumption in liters using the Combustion Consumption Model. Included if vehicleEngineType is set to combustion and constantSpeedConsumptionInLitersPerHundredkm is specified. The value will be non-negative.
battery_consumption_in_kw_h (float) – Estimated electric energy consumption in kilowatt hours (kWh) using the Electric Consumption Model. Included if vehicleEngineType is set to electric and constantSpeedConsumptionInkWhPerHundredkm is specified. The value of batteryConsumptionInkWh includes the recuperated electric energy and can therefore be negative (which indicates gaining energy). If both maxChargeInkWh and currentChargeInkWh are specified, recuperation will be capped to ensure that the battery charge level never exceeds maxChargeInkWh. If neither maxChargeInkWh nor currentChargeInkWh are specified, unconstrained recuperation is assumed in the consumption calculation.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteMatrixQuery(*, origins: Optional[_models.GeoJsonMultiPoint] = None, destinations: Optional[_models.GeoJsonMultiPoint] = None, **kwargs)[source]¶

An object with a matrix of coordinates.

Variables

origins (GeoJsonMultiPoint) –
A valid GeoJSON MultiPoint geometry type. Please refer to RFC 7946 for details.
destinations (GeoJsonMultiPoint) –
A valid GeoJSON MultiPoint geometry type. Please refer to RFC 7946 for details.

Keyword Arguments

origins (GeoJsonMultiPoint) –
A valid GeoJSON MultiPoint geometry type. Please refer to RFC 7946 for details.
destinations (GeoJsonMultiPoint) –
A valid GeoJSON MultiPoint geometry type. Please refer to RFC 7946 for details.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteMatrixResult(**kwargs)[source]¶

This object is returned from a successful Route Matrix call. For ex, if 2 origins and 3 destinations are provided, there are going to 2 arrays with 3 elements in each. Each element’s content depends on the options provided in the query.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

format_version (str) – Format Version property.
matrix (list[list[RouteMatrix]]) – Results as a 2 dimensional array of route summaries.
summary (RouteMatrixSummary) – Summary object.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteMatrixSummary(**kwargs)[source]¶

Summary object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

successful_routes (int) – Number of successful routes in the response.
total_routes (int) – Total number of routes requested. Number of cells in the input matrix.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteOptimizedWaypoint(**kwargs)[source]¶

Optimized way point object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provided_index (int) – Way point index provided by the user.
optimized_index (int) – Optimized way point index from the system.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteRangeResult(*, reachable_range: Optional[_models.RouteRange] = None, report: Optional[_models.RouteReport] = None, **kwargs)[source]¶

This object is returned from a successful Route Reachable Range call.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

format_version (str) – Format Version property.
reachable_range (RouteRange) – Reachable Range.
report (RouteReport) – Reports the effective settings used in the current call.

Keyword Arguments

reachable_range (RouteRange) – Reachable Range.
report (RouteReport) – Reports the effective settings used in the current call.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteRepresentationForBestOrder(value)[source]¶

RouteRepresentationForBestOrder.

NONE = 'none'¶: Includes only the optimized waypoint indices but does not include the route geometry in the response.

POLYLINE = 'polyline'¶: Includes route geometry in the response.

SUMMARY_ONLY = 'summaryOnly'¶: Summary as per polyline but excluding the point geometry elements for the routes in the response.

class azure.maps.route.models.RouteSectionTec(*, causes: Optional[List[_models.RouteSectionTecCause]] = None, **kwargs)[source]¶

Details of the traffic event, using definitions in the TPEG2-TEC standard. Can contain effectCode and causes elements.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

effect_code (int) –
The effect on the traffic flow. Contains a value in the tec001:EffectCode table, as defined in the TPEG2-TEC standard. Can be used to color-code traffic events according to severity.
causes (list[RouteSectionTecCause]) – Causes array.

Keyword Arguments

causes (list[RouteSectionTecCause]) – Causes array.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteSummary(**kwargs)[source]¶

Summary object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

length_in_meters (int) – Length In Meters property.
travel_time_in_seconds (int) – Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data.
traffic_delay_in_seconds (int) – Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added.
departure_time (datetime) – The estimated departure time for the route or leg.
arrival_time (datetime) – The estimated arrival time for the route or leg.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: key_transformer (function) – A key transformer function.
Returns: A dict JSON compatible object
Return type: dict

classmethod deserialize(data, content_type=None)¶

Parse a str using the RestAPI syntax and return a model.

Parameters

data (str) – A str using RestAPI structure. JSON by default.
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod enable_additional_properties_sending()¶

classmethod from_dict(data, key_extractors=None, content_type=None)¶

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

Parameters

data (dict) – A dict using RestAPI structure
content_type (str) – JSON by default, set application/xml if XML.

Returns

An instance of this model

Raises

DeserializationError if something went wrong

classmethod is_xml_model()¶

serialize(keep_readonly=False, **kwargs)¶

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

Parameters: keep_readonly (bool) – If you want to serialize the readonly attributes
Returns: A dict JSON compatible object
Return type: dict

class azure.maps.route.models.RouteType(value)[source]¶

RouteType.

ECONOMY = 'eco'¶: A route balanced by economy and speed.

FASTEST = 'fastest'¶: The fastest route.

SHORTEST = 'shortest'¶: The shortest route by distance.

THRILLING = 'thrilling'¶: Includes interesting or challenging roads and uses as few motorways as possible. You can choose the level of turns included and also the degree of hilliness. See the hilliness and windingness parameters for how to set this. There is a limit of 900 km on routes planned with routeType=thrilling

class azure.maps.route.models.SectionType(value)[source]¶

SectionType.

CARPOOL = 'carpool'¶: Sections of the route that require use of carpool (HOV/High Occupancy Vehicle) lanes.

CAR_OR_TRAIN = 'carTrain'¶: Sections of the route that are cars or trains.

COUNTRY = 'country'¶: Sections indicating which countries the route is in.

FERRY = 'ferry'¶: Sections of the route that are ferries.

MOTORWAY = 'motorway'¶: Sections of the route that are motorways.

PEDESTRIAN = 'pedestrian'¶: Sections of the route that are only suited for pedestrians.

TOLL_ROAD = 'tollRoad'¶: Sections of the route that require a toll to be payed.

TOLL_VIGNETTE = 'tollVignette'¶: Sections of the route that require a toll vignette to be present.

TRAFFIC = 'traffic'¶: Sections of the route that contain traffic information.

TRAVEL_MODE = 'travelMode'¶: Sections in relation to the request parameter travelMode.

TUNNEL = 'tunnel'¶: Sections of the route that are tunnels.

URBAN = 'urban'¶: Sections of the route that are located within urban areas.

class azure.maps.route.models.TravelMode(value)[source]¶

Travel mode for the calculated route. The value will be set to other if the requested mode of transport is not possible in this section.

BICYCLE = 'bicycle'¶: The returned routes are optimized for bicycles, including use of bicycle lanes.

BUS = 'bus'¶: The returned routes are optimized for buses, including the use of bus only lanes. BETA functionality.

CAR = 'car'¶: The returned routes are optimized for cars.

MOTORCYCLE = 'motorcycle'¶: The returned routes are optimized for motorcycles. BETA functionality.

OTHER = 'other'¶: The given mode of transport is not possible in this section

PEDESTRIAN = 'pedestrian'¶: The returned routes are optimized for pedestrians, including the use of sidewalks.

TAXI = 'taxi'¶: The returned routes are optimized for taxis. BETA functionality.

TRUCK = 'truck'¶: The returned routes are optimized for commercial vehicles, like for trucks.

VAN = 'van'¶: The returned routes are optimized for vans. BETA functionality.

class azure.maps.route.models.VehicleEngineType(value)[source]¶

VehicleEngineType.

COMBUSTION = 'combustion'¶: Internal combustion engine.

ELECTRIC = 'electric'¶: Electric engine.

class azure.maps.route.models.VehicleLoadType(value)[source]¶

VehicleLoadType.

OTHER_HAZMAT_EXPLOSIVE = 'otherHazmatExplosive'¶: Explosives

OTHER_HAZMAT_GENERAL = 'otherHazmatGeneral'¶: Miscellaneous

OTHER_HAZMAT_HARMFUL_TO_WATER = 'otherHazmatHarmfulToWater'¶: Harmful to water

US_HAZMAT_CLASS1 = 'USHazmatClass1'¶: Explosives

US_HAZMAT_CLASS2 = 'USHazmatClass2'¶: Compressed gas

US_HAZMAT_CLASS3 = 'USHazmatClass3'¶: Flammable liquids

US_HAZMAT_CLASS4 = 'USHazmatClass4'¶: Flammable solids

US_HAZMAT_CLASS5 = 'USHazmatClass5'¶: Oxidizers

US_HAZMAT_CLASS6 = 'USHazmatClass6'¶: Poisons

US_HAZMAT_CLASS7 = 'USHazmatClass7'¶: Radioactive

US_HAZMAT_CLASS8 = 'USHazmatClass8'¶: Corrosives

US_HAZMAT_CLASS9 = 'USHazmatClass9'¶: Miscellaneous

class azure.maps.route.models.WindingnessLevel(value)[source]¶

WindingnessLevel.

HIGH = 'high'¶: high

LOW = 'low'¶: low

NORMAL = 'normal'¶: normal