Class SamplingRateBoost

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

Enable temporary sampling rate increases when you detect anomalies to improve visibility.

See Also:

  • Method Details

    • maxRate

      public final Double maxRate()

      Defines max temporary sampling rate to apply when a boost is triggered. Calculated boost rate by X-Ray will be less than or equal to this max rate.

      Returns:
      Defines max temporary sampling rate to apply when a boost is triggered. Calculated boost rate by X-Ray will be less than or equal to this max rate.

    • cooldownWindowMinutes

      public final Integer cooldownWindowMinutes()

      Sets the time window (in minutes) in which only one sampling rate boost can be triggered. After a boost occurs, no further boosts are allowed until the next window.

      Returns:
      Sets the time window (in minutes) in which only one sampling rate boost can be triggered. After a boost occurs, no further boosts are allowed until the next window.

    • toBuilder

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

    • builder

      public static SamplingRateBoost.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SamplingRateBoost.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.