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

Class SamplingTargetDocument

java.lang.Object
software.amazon.awssdk.services.xray.model.SamplingTargetDocument
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SamplingTargetDocument.Builder,SamplingTargetDocument>
@Generated("software.amazon.awssdk:codegen") public final class SamplingTargetDocument extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SamplingTargetDocument.Builder,SamplingTargetDocument>

Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.

See Also:

  • Method Details

    • ruleName

      public final String ruleName()

      The name of the sampling rule.

      Returns:
      The name of the sampling rule.

    • fixedRate

      public final Double fixedRate()

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

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

    • reservoirQuota

      public final Integer reservoirQuota()

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

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

    • reservoirQuotaTTL

      public final Instant reservoirQuotaTTL()

      When the reservoir quota expires.

      Returns:
      When the reservoir quota expires.

    • interval

      public final Integer interval()

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

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

    • toBuilder

      public SamplingTargetDocument.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<SamplingTargetDocument.Builder,SamplingTargetDocument>
      Returns:
      a builder for type T

    • builder

      public static SamplingTargetDocument.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

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

    • getValueForField

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

    • sdkFields

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