Interface SamplingTargetDocument.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SamplingTargetDocument.Builder,SamplingTargetDocument>, SdkBuilder<SamplingTargetDocument.Builder,SamplingTargetDocument>, SdkPojo
Enclosing class:
SamplingTargetDocument
@Mutable @NotThreadSafe public static interface SamplingTargetDocument.Builder extends SdkPojo, CopyableBuilder<SamplingTargetDocument.Builder,SamplingTargetDocument>

  • Method Details

    • ruleName

      SamplingTargetDocument.Builder ruleName(String ruleName)

      The name of the sampling rule.

      Parameters:
      ruleName - The name of the sampling rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fixedRate

      SamplingTargetDocument.Builder fixedRate(Double fixedRate)

      The percentage of matching requests to instrument, after the reservoir is exhausted.

      Parameters:
      fixedRate - The percentage of matching requests to instrument, after the reservoir is exhausted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reservoirQuota

      SamplingTargetDocument.Builder reservoirQuota(Integer reservoirQuota)

      The number of requests per second that X-Ray allocated for this service.

      Parameters:
      reservoirQuota - The number of requests per second that X-Ray allocated for this service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reservoirQuotaTTL

      SamplingTargetDocument.Builder reservoirQuotaTTL(Instant reservoirQuotaTTL)

      When the reservoir quota expires.

      Parameters:
      reservoirQuotaTTL - When the reservoir quota expires.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • interval

      SamplingTargetDocument.Builder interval(Integer interval)

      The number of seconds for the service to wait before getting sampling targets again.

      Parameters:
      interval - The number of seconds for the service to wait before getting sampling targets again.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • samplingBoost

      SamplingTargetDocument.Builder samplingBoost(SamplingBoost samplingBoost)

      The sampling boost that X-Ray allocated for this service.

      Parameters:
      samplingBoost - The sampling boost that X-Ray allocated for this service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • samplingBoost

      default SamplingTargetDocument.Builder samplingBoost(Consumer<SamplingBoost.Builder> samplingBoost)

      The sampling boost that X-Ray allocated for this service.

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

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

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