TraceSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.xray.model.TraceSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TraceSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Metadata generated from the segment documents in a trace.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TraceSummary()

Constructors
Constructor and Description
`TraceSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TraceSummary`	`addAnnotationsEntry(String key, List<ValueWithServiceIds> value)`
`TraceSummary`	`clearAnnotationsEntries()` Removes all the entries added into Annotations.
`TraceSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,List<ValueWithServiceIds>>`	`getAnnotations()` Annotations from the trace's segment documents.
`Double`	`getDuration()` The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
`Boolean`	`getHasError()` One or more of the segment documents has a 400 series error.
`Boolean`	`getHasFault()` One or more of the segment documents has a 500 series error.
`Boolean`	`getHasThrottle()` One or more of the segment documents has a 429 throttling error.
`Http`	`getHttp()` Information about the HTTP request served by the trace.
`String`	`getId()` The unique identifier for the request that generated the trace's segments and subsegments.
`Boolean`	`getIsPartial()` One or more of the segment documents is in progress.
`Double`	`getResponseTime()` The length of time in seconds between the start and end times of the root segment.
`List<ServiceId>`	`getServiceIds()` Service IDs from the trace's segment documents.
`List<TraceUser>`	`getUsers()` Users from the trace's segment documents.
`int`	`hashCode()`
`Boolean`	`isHasError()` One or more of the segment documents has a 400 series error.
`Boolean`	`isHasFault()` One or more of the segment documents has a 500 series error.
`Boolean`	`isHasThrottle()` One or more of the segment documents has a 429 throttling error.
`Boolean`	`isPartial()` One or more of the segment documents is in progress.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAnnotations(Map<String,List<ValueWithServiceIds>> annotations)` Annotations from the trace's segment documents.
`void`	`setDuration(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.
`void`	`setHasError(Boolean hasError)` One or more of the segment documents has a 400 series error.
`void`	`setHasFault(Boolean hasFault)` One or more of the segment documents has a 500 series error.
`void`	`setHasThrottle(Boolean hasThrottle)` One or more of the segment documents has a 429 throttling error.
`void`	`setHttp(Http http)` Information about the HTTP request served by the trace.
`void`	`setId(String id)` The unique identifier for the request that generated the trace's segments and subsegments.
`void`	`setIsPartial(Boolean isPartial)` One or more of the segment documents is in progress.
`void`	`setResponseTime(Double responseTime)` The length of time in seconds between the start and end times of the root segment.
`void`	`setServiceIds(Collection<ServiceId> serviceIds)` Service IDs from the trace's segment documents.
`void`	`setUsers(Collection<TraceUser> users)` Users from the trace's segment documents.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TraceSummary`	`withAnnotations(Map<String,List<ValueWithServiceIds>> annotations)` Annotations from the trace's segment documents.
`TraceSummary`	`withDuration(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.
`TraceSummary`	`withHasError(Boolean hasError)` One or more of the segment documents has a 400 series error.
`TraceSummary`	`withHasFault(Boolean hasFault)` One or more of the segment documents has a 500 series error.
`TraceSummary`	`withHasThrottle(Boolean hasThrottle)` One or more of the segment documents has a 429 throttling error.
`TraceSummary`	`withHttp(Http http)` Information about the HTTP request served by the trace.
`TraceSummary`	`withId(String id)` The unique identifier for the request that generated the trace's segments and subsegments.
`TraceSummary`	`withIsPartial(Boolean isPartial)` One or more of the segment documents is in progress.
`TraceSummary`	`withResponseTime(Double responseTime)` The length of time in seconds between the start and end times of the root segment.
`TraceSummary`	`withServiceIds(Collection<ServiceId> serviceIds)` Service IDs from the trace's segment documents.
`TraceSummary`	`withServiceIds(ServiceId... serviceIds)` Service IDs from the trace's segment documents.
`TraceSummary`	`withUsers(Collection<TraceUser> users)` Users from the trace's segment documents.
`TraceSummary`	`withUsers(TraceUser... users)` Users from the trace's segment documents.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TraceSummary
```
public TraceSummary()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The unique identifier for the request that generated the trace's segments and subsegments.
    
    Parameters:
    
    id - The unique identifier for the request that generated the trace's segments and subsegments.
  - getId
```
public String getId()
```
    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.
  - withId
```
public TraceSummary withId(String id)
```
    The unique identifier for the request that generated the trace's segments and subsegments.
    
    Parameters:
    
    id - The unique identifier for the request that generated the trace's segments and subsegments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDuration
```
public void setDuration(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.
    
    Parameters:
    
    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.
  - getDuration
```
public Double getDuration()
```
    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.
  - withDuration
```
public TraceSummary withDuration(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResponseTime
```
public void setResponseTime(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.
    
    Parameters:
    
    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.
  - getResponseTime
```
public Double getResponseTime()
```
    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.
  - withResponseTime
```
public TraceSummary withResponseTime(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHasFault
```
public void setHasFault(Boolean hasFault)
```
    One or more of the segment documents has a 500 series error.
    
    Parameters:
    
    hasFault - One or more of the segment documents has a 500 series error.
  - getHasFault
```
public Boolean getHasFault()
```
    One or more of the segment documents has a 500 series error.
    
    Returns:
    
    One or more of the segment documents has a 500 series error.
  - withHasFault
```
public TraceSummary withHasFault(Boolean hasFault)
```
    One or more of the segment documents has a 500 series error.
    
    Parameters:
    
    hasFault - One or more of the segment documents has a 500 series error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isHasFault
```
public Boolean isHasFault()
```
    One or more of the segment documents has a 500 series error.
    
    Returns:
    
    One or more of the segment documents has a 500 series error.
  - setHasError
```
public void setHasError(Boolean hasError)
```
    One or more of the segment documents has a 400 series error.
    
    Parameters:
    
    hasError - One or more of the segment documents has a 400 series error.
  - getHasError
```
public Boolean getHasError()
```
    One or more of the segment documents has a 400 series error.
    
    Returns:
    
    One or more of the segment documents has a 400 series error.
  - withHasError
```
public TraceSummary withHasError(Boolean hasError)
```
    One or more of the segment documents has a 400 series error.
    
    Parameters:
    
    hasError - One or more of the segment documents has a 400 series error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isHasError
```
public Boolean isHasError()
```
    One or more of the segment documents has a 400 series error.
    
    Returns:
    
    One or more of the segment documents has a 400 series error.
  - setHasThrottle
```
public void setHasThrottle(Boolean hasThrottle)
```
    One or more of the segment documents has a 429 throttling error.
    
    Parameters:
    
    hasThrottle - One or more of the segment documents has a 429 throttling error.
  - getHasThrottle
```
public Boolean getHasThrottle()
```
    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.
  - withHasThrottle
```
public TraceSummary withHasThrottle(Boolean hasThrottle)
```
    One or more of the segment documents has a 429 throttling error.
    
    Parameters:
    
    hasThrottle - One or more of the segment documents has a 429 throttling error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isHasThrottle
```
public Boolean isHasThrottle()
```
    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.
  - setIsPartial
```
public void setIsPartial(Boolean isPartial)
```
    One or more of the segment documents is in progress.
    
    Parameters:
    
    isPartial - One or more of the segment documents is in progress.
  - getIsPartial
```
public Boolean getIsPartial()
```
    One or more of the segment documents is in progress.
    
    Returns:
    
    One or more of the segment documents is in progress.
  - withIsPartial
```
public TraceSummary withIsPartial(Boolean isPartial)
```
    One or more of the segment documents is in progress.
    
    Parameters:
    
    isPartial - One or more of the segment documents is in progress.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPartial
```
public Boolean isPartial()
```
    One or more of the segment documents is in progress.
    
    Returns:
    
    One or more of the segment documents is in progress.
  - setHttp
```
public void setHttp(Http http)
```
    Information about the HTTP request served by the trace.
    
    Parameters:
    
    http - Information about the HTTP request served by the trace.
  - getHttp
```
public Http getHttp()
```
    Information about the HTTP request served by the trace.
    
    Returns:
    
    Information about the HTTP request served by the trace.
  - withHttp
```
public TraceSummary withHttp(Http http)
```
    Information about the HTTP request served by the trace.
    
    Parameters:
    
    http - Information about the HTTP request served by the trace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAnnotations
```
public Map<String,List<ValueWithServiceIds>> getAnnotations()
```
    Annotations from the trace's segment documents.
    
    Returns:
    
    Annotations from the trace's segment documents.
  - setAnnotations
```
public void setAnnotations(Map<String,List<ValueWithServiceIds>> annotations)
```
    Annotations from the trace's segment documents.
    
    Parameters:
    
    annotations - Annotations from the trace's segment documents.
  - withAnnotations
```
public TraceSummary withAnnotations(Map<String,List<ValueWithServiceIds>> annotations)
```
    Annotations from the trace's segment documents.
    
    Parameters:
    
    annotations - Annotations from the trace's segment documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAnnotationsEntry
```
public TraceSummary addAnnotationsEntry(String key,
                                        List<ValueWithServiceIds> value)
```
  - clearAnnotationsEntries
```
public TraceSummary clearAnnotationsEntries()
```
    Removes all the entries added into Annotations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUsers
```
public List<TraceUser> getUsers()
```
    Users from the trace's segment documents.
    
    Returns:
    
    Users from the trace's segment documents.
  - setUsers
```
public void setUsers(Collection<TraceUser> users)
```
    Users from the trace's segment documents.
    
    Parameters:
    
    users - Users from the trace's segment documents.
  - withUsers
```
public TraceSummary withUsers(TraceUser... users)
```
    Users from the trace's segment documents.
    
    NOTE: This method appends the values to the existing list (if any). Use setUsers(java.util.Collection) or withUsers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    users - Users from the trace's segment documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUsers
```
public TraceSummary withUsers(Collection<TraceUser> users)
```
    Users from the trace's segment documents.
    
    Parameters:
    
    users - Users from the trace's segment documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getServiceIds
```
public List<ServiceId> getServiceIds()
```
    Service IDs from the trace's segment documents.
    
    Returns:
    
    Service IDs from the trace's segment documents.
  - setServiceIds
```
public void setServiceIds(Collection<ServiceId> serviceIds)
```
    Service IDs from the trace's segment documents.
    
    Parameters:
    
    serviceIds - Service IDs from the trace's segment documents.
  - withServiceIds
```
public TraceSummary withServiceIds(ServiceId... serviceIds)
```
    Service IDs from the trace's segment documents.
    
    NOTE: This method appends the values to the existing list (if any). Use setServiceIds(java.util.Collection) or withServiceIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    serviceIds - Service IDs from the trace's segment documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withServiceIds
```
public TraceSummary withServiceIds(Collection<ServiceId> serviceIds)
```
    Service IDs from the trace's segment documents.
    
    Parameters:
    
    serviceIds - Service IDs from the trace's segment documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TraceSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class TraceSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TraceSummary

Method Detail

setId

getId

withId

setDuration

getDuration

withDuration

setResponseTime

getResponseTime

withResponseTime

setHasFault

getHasFault

withHasFault

isHasFault

setHasError

getHasError

withHasError

isHasError

setHasThrottle

getHasThrottle

withHasThrottle

isHasThrottle

setIsPartial

getIsPartial

withIsPartial

isPartial

setHttp

getHttp

withHttp

getAnnotations

setAnnotations

withAnnotations

addAnnotationsEntry

clearAnnotationsEntries

getUsers

setUsers

withUsers

withUsers

getServiceIds

setServiceIds

withServiceIds

withServiceIds

toString

equals

hashCode

clone

marshall