Class Edge

    • Method Detail

      • referenceId

        public final Integer referenceId()

        Identifier of the edge. Unique within a service map.

        Returns:
        Identifier of the edge. Unique within a service map.
      • startTime

        public final Instant startTime()

        The start time of the first segment on the edge.

        Returns:
        The start time of the first segment on the edge.
      • endTime

        public final Instant endTime()

        The end time of the last segment on the edge.

        Returns:
        The end time of the last segment on the edge.
      • summaryStatistics

        public final EdgeStatistics summaryStatistics()

        Response statistics for segments on the edge.

        Returns:
        Response statistics for segments on the edge.
      • hasResponseTimeHistogram

        public final boolean hasResponseTimeHistogram()
        For responses, this returns true if the service returned a value for the ResponseTimeHistogram property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • responseTimeHistogram

        public final List<HistogramEntry> responseTimeHistogram()

        A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResponseTimeHistogram() method.

        Returns:
        A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges.
      • hasAliases

        public final boolean hasAliases()
        For responses, this returns true if the service returned a value for the Aliases property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • aliases

        public final List<Alias> aliases()

        Aliases for the edge.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAliases() method.

        Returns:
        Aliases for the edge.
      • edgeType

        public final String edgeType()

        Describes an asynchronous connection, with a value of link.

        Returns:
        Describes an asynchronous connection, with a value of link.
      • hasReceivedEventAgeHistogram

        public final boolean hasReceivedEventAgeHistogram()
        For responses, this returns true if the service returned a value for the ReceivedEventAgeHistogram property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • receivedEventAgeHistogram

        public final List<HistogramEntry> receivedEventAgeHistogram()

        A histogram that maps the spread of event age when received by consumers. Age is calculated each time an event is received. Only populated when EdgeType is link.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReceivedEventAgeHistogram() method.

        Returns:
        A histogram that maps the spread of event age when received by consumers. Age is calculated each time an event is received. Only populated when EdgeType is link.
      • serializableBuilderClass

        public static Class<? extends Edge.Builder> serializableBuilderClass()
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)