software.amazon.awssdk.services.xray.model

Class Segment

java.lang.Object

software.amazon.awssdk.services.xray.model.Segment

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Segment.Builder,Segment>

@Generated(value="software.amazon.awssdk:codegen")
public final class Segment
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Segment.Builder,Segment>

A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with PutTraceSegments, or an inferred segment for a downstream service, generated from a subsegment sent by the service that called it.

For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Segment.Builder

Method Summary

Modifier and Type	Method and Description
static Segment.Builder	builder()
String	document() The segment document.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The segment's ID.
List<SdkField<?>>	sdkFields()
static Class<? extends Segment.Builder>	serializableBuilderClass()
Segment.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public String id()

The segment's ID.

Returns:

The segment's ID.

document

public String document()

The segment document.

Returns:

The segment document.

toBuilder

public Segment.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<Segment.Builder,Segment>

Returns:

a builder for type T

builder

public static Segment.Builder builder()

serializableBuilderClass

public static Class<? extends Segment.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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