Package com.azure.maps.route.models

Class RouteInstructionGroup

java.lang.Object
com.azure.maps.route.models.RouteInstructionGroup
All Implemented Interfaces:
com.azure.json.JsonSerializable<RouteInstructionGroup>
public final class RouteInstructionGroup extends Object implements com.azure.json.JsonSerializable<RouteInstructionGroup>
Groups a sequence of instruction elements which are related to each other. The sequence range is constrained with firstInstructionIndex and lastInstructionIndex. When human-readable text messages are requested for guidance (instructionType=text or tagged), then the instructionGroup has a summary message returned when available.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RouteInstructionGroup()
    Creates an instance of RouteInstructionGroup class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RouteInstructionGroup
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RouteInstructionGroup from the JsonReader.
    Integer
    getFirstInstructionIndex()
    Get the firstInstructionIndex property: Index of the first instruction in the instructions and belonging to this group.
    Integer
    getGroupLengthInMeters()
    Get the groupLengthInMeters property: Length of the group.
    String
    getGroupMessage()
    Get the groupMessage property: Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged).
    Integer
    getLastInstructionIndex()
    Get the lastInstructionIndex property: Index of the last instruction in the instructions and belonging to this group.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • RouteInstructionGroup

      public RouteInstructionGroup()
      Creates an instance of RouteInstructionGroup class.

  • Method Details

    • getFirstInstructionIndex

      public Integer getFirstInstructionIndex()
      Get the firstInstructionIndex property: Index of the first instruction in the instructions and belonging to this group.
      Returns:
      the firstInstructionIndex value.

    • getLastInstructionIndex

      public Integer getLastInstructionIndex()
      Get the lastInstructionIndex property: Index of the last instruction in the instructions and belonging to this group.
      Returns:
      the lastInstructionIndex value.

    • getGroupLengthInMeters

      public Integer getGroupLengthInMeters()
      Get the groupLengthInMeters property: Length of the group.
      Returns:
      the groupLengthInMeters value.

    • getGroupMessage

      public String getGroupMessage()
      Get the groupMessage property: Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged).
      Returns:
      the groupMessage value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<RouteInstructionGroup>
      Throws:
      IOException

    • fromJson

      public static RouteInstructionGroup fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of RouteInstructionGroup from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of RouteInstructionGroup if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the RouteInstructionGroup.