Class Trace
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Trace.Builder,
Trace>
A collection of segment documents with matching trace IDs.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Trace.Builder
builder()
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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Segments property.final String
id()
The unique identifier for the request that generated the trace's segments and subsegments.final Boolean
LimitExceeded is set to true when the trace has exceeded theTrace document size
limit.segments()
Segment documents for the segments and subsegments that comprise the trace.static Class
<? extends Trace.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
-
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.
-
limitExceeded
LimitExceeded is set to true when the trace has exceeded the
Trace document size
limit. For more information about this limit and other X-Ray limits and quotas, see Amazon Web Services X-Ray endpoints and quotas.- Returns:
- LimitExceeded is set to true when the trace has exceeded the
Trace document size
limit. For more information about this limit and other X-Ray limits and quotas, see Amazon Web Services X-Ray endpoints and quotas.
-
hasSegments
public final boolean hasSegments()For responses, this returns true if the service returned a value for the Segments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
segments
Segment documents for the segments and subsegments that comprise the trace.
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
hasSegments()
method.- Returns:
- Segment documents for the segments and subsegments that comprise the trace.
-
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 interfaceToCopyableBuilder<Trace.Builder,
Trace> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-