Class SamplingRule

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

A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.

See Also:

  • Method Details

    • ruleName

      public final String ruleName()

      The name of the sampling rule. Specify a rule by either name or ARN, but not both.

      Returns:
      The name of the sampling rule. Specify a rule by either name or ARN, but not both.

    • ruleARN

      public final String ruleARN()

      The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

      Returns:
      The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

    • resourceARN

      public final String resourceARN()

      Matches the ARN of the Amazon Web Services resource on which the service runs.

      Returns:
      Matches the ARN of the Amazon Web Services resource on which the service runs.

    • priority

      public final Integer priority()

      The priority of the sampling rule.

      Returns:
      The priority 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.

    • reservoirSize

      public final Integer reservoirSize()

      A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

      Returns:
      A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

    • serviceName

      public final String serviceName()

      Matches the name that the service uses to identify itself in segments.

      Returns:
      Matches the name that the service uses to identify itself in segments.

    • serviceType

      public final String serviceType()

      Matches the origin that the service uses to identify its type in segments.

      Returns:
      Matches the origin that the service uses to identify its type in segments.

    • host

      public final String host()

      Matches the hostname from a request URL.

      Returns:
      Matches the hostname from a request URL.

    • httpMethod

      public final String httpMethod()

      Matches the HTTP method of a request.

      Returns:
      Matches the HTTP method of a request.

    • urlPath

      public final String urlPath()

      Matches the path from a request URL.

      Returns:
      Matches the path from a request URL.

    • version

      public final Integer version()

      The version of the sampling rule format (1).

      Returns:
      The version of the sampling rule format (1).

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • attributes

      public final Map<String,String> attributes()

      Matches attributes derived from the request.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

      Returns:
      Matches attributes derived from the request.

    • samplingRateBoost

      public final SamplingRateBoost samplingRateBoost()

      Specifies the multiplier applied to the base sampling rate. This boost allows you to temporarily increase sampling without changing the rule's configuration.

      Returns:
      Specifies the multiplier applied to the base sampling rate. This boost allows you to temporarily increase sampling without changing the rule's configuration.

    • toBuilder

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

    • builder

      public static SamplingRule.Builder builder()

    • serializableBuilderClass

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