Package software.amazon.awssdk.services.xray.model

Class TraceSummary

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

Metadata generated from the segment documents in a trace.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier for the request that generated the trace's segments and subsegments.

      Returns:
      The unique identifier for the request that generated the trace's segments and subsegments.

    • startTime

      public final Instant startTime()

      The start time of a trace, based on the earliest trace segment start time.

      Returns:
      The start time of a trace, based on the earliest trace segment start time.

    • duration

      public final Double duration()

      The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

      Returns:
      The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

    • responseTime

      public final Double responseTime()

      The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.

      Returns:
      The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.

    • hasFault

      public final Boolean hasFault()

      The root segment document has a 500 series error.

      Returns:
      The root segment document has a 500 series error.

    • hasError

      public final Boolean hasError()

      The root segment document has a 400 series error.

      Returns:
      The root segment document has a 400 series error.

    • hasThrottle

      public final Boolean hasThrottle()

      One or more of the segment documents has a 429 throttling error.

      Returns:
      One or more of the segment documents has a 429 throttling error.

    • isPartial

      public final Boolean isPartial()

      One or more of the segment documents is in progress.

      Returns:
      One or more of the segment documents is in progress.

    • http

      public final Http http()

      Information about the HTTP request served by the trace.

      Returns:
      Information about the HTTP request served by the trace.

    • hasAnnotations

      public final boolean hasAnnotations()
      For responses, this returns true if the service returned a value for the Annotations 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.

    • annotations

      public final Map<String,List<ValueWithServiceIds>> annotations()

      Annotations from the trace's segment documents.

      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 hasAnnotations() method.

      Returns:
      Annotations from the trace's segment documents.

    • hasUsers

      public final boolean hasUsers()
      For responses, this returns true if the service returned a value for the Users 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.

    • users

      public final List<TraceUser> users()

      Users from the trace's segment documents.

      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 hasUsers() method.

      Returns:
      Users from the trace's segment documents.

    • hasServiceIds

      public final boolean hasServiceIds()
      For responses, this returns true if the service returned a value for the ServiceIds 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.

    • serviceIds

      public final List<ServiceId> serviceIds()

      Service IDs from the trace's segment documents.

      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 hasServiceIds() method.

      Returns:
      Service IDs from the trace's segment documents.

    • hasResourceARNs

      public final boolean hasResourceARNs()
      For responses, this returns true if the service returned a value for the ResourceARNs 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.

    • resourceARNs

      public final List<ResourceARNDetail> resourceARNs()

      A list of resource ARNs for any resource corresponding to the trace segments.

      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 hasResourceARNs() method.

      Returns:
      A list of resource ARNs for any resource corresponding to the trace segments.

    • hasInstanceIds

      public final boolean hasInstanceIds()
      For responses, this returns true if the service returned a value for the InstanceIds 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.

    • instanceIds

      public final List<InstanceIdDetail> instanceIds()

      A list of EC2 instance IDs for any instance corresponding to the trace segments.

      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 hasInstanceIds() method.

      Returns:
      A list of EC2 instance IDs for any instance corresponding to the trace segments.

    • hasAvailabilityZones

      public final boolean hasAvailabilityZones()
      For responses, this returns true if the service returned a value for the AvailabilityZones 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.

    • availabilityZones

      public final List<AvailabilityZoneDetail> availabilityZones()

      A list of Availability Zones for any zone corresponding to the trace segments.

      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 hasAvailabilityZones() method.

      Returns:
      A list of Availability Zones for any zone corresponding to the trace segments.

    • entryPoint

      public final ServiceId entryPoint()

      The root of a trace.

      Returns:
      The root of a trace.

    • hasFaultRootCauses

      public final boolean hasFaultRootCauses()
      For responses, this returns true if the service returned a value for the FaultRootCauses 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.

    • faultRootCauses

      public final List<FaultRootCause> faultRootCauses()

      A collection of FaultRootCause structures corresponding to the trace segments.

      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 hasFaultRootCauses() method.

      Returns:
      A collection of FaultRootCause structures corresponding to the trace segments.

    • hasErrorRootCauses

      public final boolean hasErrorRootCauses()
      For responses, this returns true if the service returned a value for the ErrorRootCauses 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.

    • errorRootCauses

      public final List<ErrorRootCause> errorRootCauses()

      A collection of ErrorRootCause structures corresponding to the trace segments.

      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 hasErrorRootCauses() method.

      Returns:
      A collection of ErrorRootCause structures corresponding to the trace segments.

    • hasResponseTimeRootCauses

      public final boolean hasResponseTimeRootCauses()
      For responses, this returns true if the service returned a value for the ResponseTimeRootCauses 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.

    • responseTimeRootCauses

      public final List<ResponseTimeRootCause> responseTimeRootCauses()

      A collection of ResponseTimeRootCause structures corresponding to the trace segments.

      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 hasResponseTimeRootCauses() method.

      Returns:
      A collection of ResponseTimeRootCause structures corresponding to the trace segments.

    • revision

      public final Integer revision()

      The revision number of a trace.

      Returns:
      The revision number of a trace.

    • matchedEventTime

      public final Instant matchedEventTime()

      The matched time stamp of a defined event.

      Returns:
      The matched time stamp of a defined event.

    • toBuilder

      public TraceSummary.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<TraceSummary.Builder,TraceSummary>
      Returns:
      a builder for type T

    • builder

      public static TraceSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TraceSummary.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.