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

Interface SamplingRule.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SamplingRule.Builder,SamplingRule>, SdkBuilder<SamplingRule.Builder,SamplingRule>, SdkPojo
Enclosing class:
SamplingRule
public static interface SamplingRule.Builder extends SdkPojo, CopyableBuilder<SamplingRule.Builder,SamplingRule>

  • Method Details

    • ruleName

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

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

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

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

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

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

    • serviceName

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

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

    • host

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

    • httpMethod

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

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

    • version

      SamplingRule.Builder version(Integer version)

      The version of the sampling rule format (1).

      Parameters:
      version - The version of the sampling rule format (1).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

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