Interface SamplingRuleUpdate.Builder

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

  • Method Details

    • ruleName

      SamplingRuleUpdate.Builder ruleName(String ruleName)

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

      Parameters:
      ruleName - The name of the sampling rule. Specify a rule by either name or ARN, but not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleARN

      SamplingRuleUpdate.Builder ruleARN(String ruleARN)

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

      Parameters:
      ruleARN - The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceARN

      SamplingRuleUpdate.Builder resourceARN(String resourceARN)

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

      Parameters:
      resourceARN - Matches the ARN of the Amazon Web Services resource on which the service runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

      SamplingRuleUpdate.Builder priority(Integer priority)

      The priority of the sampling rule.

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

    • fixedRate

      SamplingRuleUpdate.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.

    • reservoirSize

      SamplingRuleUpdate.Builder reservoirSize(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • host

      SamplingRuleUpdate.Builder host(String host)

      Matches the hostname from a request URL.

      Parameters:
      host - Matches the hostname from a request URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceName

      SamplingRuleUpdate.Builder serviceName(String serviceName)

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

      Parameters:
      serviceName - Matches the name that the service uses to identify itself in segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceType

      SamplingRuleUpdate.Builder serviceType(String serviceType)

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

      Parameters:
      serviceType - Matches the origin that the service uses to identify its type in segments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpMethod

      SamplingRuleUpdate.Builder httpMethod(String httpMethod)

      Matches the HTTP method of a request.

      Parameters:
      httpMethod - Matches the HTTP method of a request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • urlPath

      SamplingRuleUpdate.Builder urlPath(String urlPath)

      Matches the path from a request URL.

      Parameters:
      urlPath - Matches the path from a request URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      SamplingRuleUpdate.Builder attributes(Map<String,String> attributes)

      Matches attributes derived from the request.

      Parameters:
      attributes - Matches attributes derived from the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • samplingRateBoost

      SamplingRuleUpdate.Builder samplingRateBoost(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • samplingRateBoost

      default SamplingRuleUpdate.Builder samplingRateBoost(Consumer<SamplingRateBoost.Builder> samplingRateBoost)

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

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

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

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