Trace (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Trace
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A collection of segment documents with matching trace IDs.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Trace()

Constructors
Constructor and Description
`Trace()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Trace`	`clone()`
`boolean`	`equals(Object obj)`
`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.
`String`	`getId()` The unique identifier for the request that generated the trace's segments and subsegments.
`Boolean`	`getLimitExceeded()` LimitExceeded is set to true when the trace has exceeded one of the defined quotas.
`List<Segment>`	`getSegments()` Segment documents for the segments and subsegments that comprise the trace.
`int`	`hashCode()`
`Boolean`	`isLimitExceeded()` LimitExceeded is set to true when the trace has exceeded one of the defined quotas.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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`	`setId(String id)` The unique identifier for the request that generated the trace's segments and subsegments.
`void`	`setLimitExceeded(Boolean limitExceeded)` LimitExceeded is set to true when the trace has exceeded one of the defined quotas.
`void`	`setSegments(Collection<Segment> segments)` Segment documents for the segments and subsegments that comprise the trace.
`String`	`toString()` Returns a string representation of this object.
`Trace`	`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.
`Trace`	`withId(String id)` The unique identifier for the request that generated the trace's segments and subsegments.
`Trace`	`withLimitExceeded(Boolean limitExceeded)` LimitExceeded is set to true when the trace has exceeded one of the defined quotas.
`Trace`	`withSegments(Collection<Segment> segments)` Segment documents for the segments and subsegments that comprise the trace.
`Trace`	`withSegments(Segment... segments)` Segment documents for the segments and subsegments that comprise the trace.

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

- Constructor Detail
  - Trace
```
public Trace()
```
- 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 Trace 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 Trace 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.
  - setLimitExceeded
```
public void setLimitExceeded(Boolean limitExceeded)
```
    LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For more information about quotas, see Amazon Web Services X-Ray endpoints and quotas.
    
    Parameters:
    
    limitExceeded - LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For more information about quotas, see Amazon Web Services X-Ray endpoints and quotas.
  - getLimitExceeded
```
public Boolean getLimitExceeded()
```
    LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For more information about quotas, see Amazon Web Services X-Ray endpoints and quotas.
    
    Returns:
    
    LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For more information about quotas, see Amazon Web Services X-Ray endpoints and quotas.
  - withLimitExceeded
```
public Trace withLimitExceeded(Boolean limitExceeded)
```
    LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For more information about quotas, see Amazon Web Services X-Ray endpoints and quotas.
    
    Parameters:
    
    limitExceeded - LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For more information about quotas, see Amazon Web Services X-Ray endpoints and quotas.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isLimitExceeded
```
public Boolean isLimitExceeded()
```
    LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For more information about quotas, see Amazon Web Services X-Ray endpoints and quotas.
    
    Returns:
    
    LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For more information about quotas, see Amazon Web Services X-Ray endpoints and quotas.
  - getSegments
```
public List<Segment> getSegments()
```
    Segment documents for the segments and subsegments that comprise the trace.
    
    Returns:
    
    Segment documents for the segments and subsegments that comprise the trace.
  - setSegments
```
public void setSegments(Collection<Segment> segments)
```
    Segment documents for the segments and subsegments that comprise the trace.
    
    Parameters:
    
    segments - Segment documents for the segments and subsegments that comprise the trace.
  - withSegments
```
public Trace withSegments(Segment... segments)
```
    Segment documents for the segments and subsegments that comprise the trace.
    
    NOTE: This method appends the values to the existing list (if any). Use setSegments(java.util.Collection) or withSegments(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    segments - Segment documents for the segments and subsegments that comprise the trace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSegments
```
public Trace withSegments(Collection<Segment> segments)
```
    Segment documents for the segments and subsegments that comprise the trace.
    
    Parameters:
    
    segments - Segment documents for the segments and subsegments that comprise the trace.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 Trace 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 Trace

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Trace

Method Detail

setId

getId

withId

setDuration

getDuration

withDuration

setLimitExceeded

getLimitExceeded

withLimitExceeded

isLimitExceeded

getSegments

setSegments

withSegments

withSegments

toString

equals

hashCode

clone

marshall