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

Interface TraceSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TraceSummary.Builder,TraceSummary>, SdkBuilder<TraceSummary.Builder,TraceSummary>, SdkPojo
Enclosing class:
TraceSummary
public static interface TraceSummary.Builder extends SdkPojo, CopyableBuilder<TraceSummary.Builder,TraceSummary>

  • Method Details

    • id

      TraceSummary.Builder id(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.

    • startTime

      TraceSummary.Builder startTime(Instant startTime)

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

      Parameters:
      startTime - The start time of a trace, based on the earliest trace segment start time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • duration

      TraceSummary.Builder duration(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.

    • responseTime

      TraceSummary.Builder responseTime(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.

    • hasFault

      TraceSummary.Builder hasFault(Boolean hasFault)

      The root segment document has a 500 series error.

      Parameters:
      hasFault - The root segment document has a 500 series error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hasError

      TraceSummary.Builder hasError(Boolean hasError)

      The root segment document has a 400 series error.

      Parameters:
      hasError - The root segment document has a 400 series error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hasThrottle

      TraceSummary.Builder hasThrottle(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.

    • isPartial

      TraceSummary.Builder isPartial(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.

    • http

      TraceSummary.Builder http(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.

    • http

      default TraceSummary.Builder http(Consumer<Http.Builder> http)

      Information about the HTTP request served by the trace.

      This is a convenience method that creates an instance of the Http.Builder avoiding the need to create one manually via Http.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to http(Http).

      Parameters:
      http - a consumer that will call methods on Http.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • annotations

      TraceSummary.Builder annotations(Map<String,? extends Collection<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.

    • users

      TraceSummary.Builder users(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.

    • users

      TraceSummary.Builder users(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.

    • users

      TraceSummary.Builder users(Consumer<TraceUser.Builder>... users)

      Users from the trace's segment documents.

      This is a convenience method that creates an instance of the TraceUser.Builder avoiding the need to create one manually via TraceUser.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to users(List<TraceUser>).

      Parameters:
      users - a consumer that will call methods on TraceUser.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serviceIds

      TraceSummary.Builder serviceIds(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.

    • serviceIds

      TraceSummary.Builder serviceIds(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.

    • serviceIds

      TraceSummary.Builder serviceIds(Consumer<ServiceId.Builder>... serviceIds)

      Service IDs from the trace's segment documents.

      This is a convenience method that creates an instance of the ServiceId.Builder avoiding the need to create one manually via ServiceId.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serviceIds(List<ServiceId>).

      Parameters:
      serviceIds - a consumer that will call methods on ServiceId.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceARNs

      TraceSummary.Builder resourceARNs(Collection<ResourceARNDetail> resourceARNs)

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

      Parameters:
      resourceARNs - A list of resource ARNs for any resource corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceARNs

      TraceSummary.Builder resourceARNs(ResourceARNDetail... resourceARNs)

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

      Parameters:
      resourceARNs - A list of resource ARNs for any resource corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceARNs

      TraceSummary.Builder resourceARNs(Consumer<ResourceARNDetail.Builder>... resourceARNs)

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

      This is a convenience method that creates an instance of the ResourceARNDetail.Builder avoiding the need to create one manually via ResourceARNDetail.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceARNs(List<ResourceARNDetail>).

      Parameters:
      resourceARNs - a consumer that will call methods on ResourceARNDetail.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceIds

      TraceSummary.Builder instanceIds(Collection<InstanceIdDetail> instanceIds)

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

      Parameters:
      instanceIds - A list of EC2 instance IDs for any instance corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceIds

      TraceSummary.Builder instanceIds(InstanceIdDetail... instanceIds)

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

      Parameters:
      instanceIds - A list of EC2 instance IDs for any instance corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceIds

      TraceSummary.Builder instanceIds(Consumer<InstanceIdDetail.Builder>... instanceIds)

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

      This is a convenience method that creates an instance of the InstanceIdDetail.Builder avoiding the need to create one manually via InstanceIdDetail.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceIds(List<InstanceIdDetail>).

      Parameters:
      instanceIds - a consumer that will call methods on InstanceIdDetail.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • availabilityZones

      TraceSummary.Builder availabilityZones(Collection<AvailabilityZoneDetail> availabilityZones)

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

      Parameters:
      availabilityZones - A list of Availability Zones for any zone corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZones

      TraceSummary.Builder availabilityZones(AvailabilityZoneDetail... availabilityZones)

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

      Parameters:
      availabilityZones - A list of Availability Zones for any zone corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZones

      TraceSummary.Builder availabilityZones(Consumer<AvailabilityZoneDetail.Builder>... availabilityZones)

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

      This is a convenience method that creates an instance of the AvailabilityZoneDetail.Builder avoiding the need to create one manually via AvailabilityZoneDetail.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to availabilityZones(List<AvailabilityZoneDetail>).

      Parameters:
      availabilityZones - a consumer that will call methods on AvailabilityZoneDetail.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • entryPoint

      TraceSummary.Builder entryPoint(ServiceId entryPoint)

      The root of a trace.

      Parameters:
      entryPoint - The root of a trace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entryPoint

      default TraceSummary.Builder entryPoint(Consumer<ServiceId.Builder> entryPoint)

      The root of a trace.

      This is a convenience method that creates an instance of the ServiceId.Builder avoiding the need to create one manually via ServiceId.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to entryPoint(ServiceId).

      Parameters:
      entryPoint - a consumer that will call methods on ServiceId.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • faultRootCauses

      TraceSummary.Builder faultRootCauses(Collection<FaultRootCause> faultRootCauses)

      A collection of FaultRootCause structures corresponding to the trace segments.

      Parameters:
      faultRootCauses - A collection of FaultRootCause structures corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faultRootCauses

      TraceSummary.Builder faultRootCauses(FaultRootCause... faultRootCauses)

      A collection of FaultRootCause structures corresponding to the trace segments.

      Parameters:
      faultRootCauses - A collection of FaultRootCause structures corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faultRootCauses

      TraceSummary.Builder faultRootCauses(Consumer<FaultRootCause.Builder>... faultRootCauses)

      A collection of FaultRootCause structures corresponding to the trace segments.

      This is a convenience method that creates an instance of the FaultRootCause.Builder avoiding the need to create one manually via FaultRootCause.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to faultRootCauses(List<FaultRootCause>).

      Parameters:
      faultRootCauses - a consumer that will call methods on FaultRootCause.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • errorRootCauses

      TraceSummary.Builder errorRootCauses(Collection<ErrorRootCause> errorRootCauses)

      A collection of ErrorRootCause structures corresponding to the trace segments.

      Parameters:
      errorRootCauses - A collection of ErrorRootCause structures corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorRootCauses

      TraceSummary.Builder errorRootCauses(ErrorRootCause... errorRootCauses)

      A collection of ErrorRootCause structures corresponding to the trace segments.

      Parameters:
      errorRootCauses - A collection of ErrorRootCause structures corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorRootCauses

      TraceSummary.Builder errorRootCauses(Consumer<ErrorRootCause.Builder>... errorRootCauses)

      A collection of ErrorRootCause structures corresponding to the trace segments.

      This is a convenience method that creates an instance of the ErrorRootCause.Builder avoiding the need to create one manually via ErrorRootCause.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to errorRootCauses(List<ErrorRootCause>).

      Parameters:
      errorRootCauses - a consumer that will call methods on ErrorRootCause.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • responseTimeRootCauses

      TraceSummary.Builder responseTimeRootCauses(Collection<ResponseTimeRootCause> responseTimeRootCauses)

      A collection of ResponseTimeRootCause structures corresponding to the trace segments.

      Parameters:
      responseTimeRootCauses - A collection of ResponseTimeRootCause structures corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • responseTimeRootCauses

      TraceSummary.Builder responseTimeRootCauses(ResponseTimeRootCause... responseTimeRootCauses)

      A collection of ResponseTimeRootCause structures corresponding to the trace segments.

      Parameters:
      responseTimeRootCauses - A collection of ResponseTimeRootCause structures corresponding to the trace segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • responseTimeRootCauses

      TraceSummary.Builder responseTimeRootCauses(Consumer<ResponseTimeRootCause.Builder>... responseTimeRootCauses)

      A collection of ResponseTimeRootCause structures corresponding to the trace segments.

      This is a convenience method that creates an instance of the ResponseTimeRootCause.Builder avoiding the need to create one manually via ResponseTimeRootCause.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to responseTimeRootCauses(List<ResponseTimeRootCause>).

      Parameters:
      responseTimeRootCauses - a consumer that will call methods on ResponseTimeRootCause.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • revision

      TraceSummary.Builder revision(Integer revision)

      The revision number of a trace.

      Parameters:
      revision - The revision number of a trace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matchedEventTime

      TraceSummary.Builder matchedEventTime(Instant matchedEventTime)

      The matched time stamp of a defined event.

      Parameters:
      matchedEventTime - The matched time stamp of a defined event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.