Class Edge

java.lang.Object
software.amazon.awssdk.services.xray.model.Edge
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Edge.Builder,Edge>
@Generated("software.amazon.awssdk:codegen") public final class Edge extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Edge.Builder,Edge>

Information about a connection between two services. An edge can be a synchronous connection, such as typical call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an SNS queue.

See Also:

  • Method Details

    • 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.

    • toBuilder

      public Edge.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Edge.Builder,Edge>
      Returns:
      a builder for type T

    • builder

      public static Edge.Builder builder()

    • 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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.