SamplingRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.xray.model.SamplingRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SamplingRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SamplingRule()

Constructors
Constructor and Description
`SamplingRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SamplingRule`	`addAttributesEntry(String key, String value)` Add a single Attributes entry
`SamplingRule`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`SamplingRule`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributes()` Matches attributes derived from the request.
`Double`	`getFixedRate()` The percentage of matching requests to instrument, after the reservoir is exhausted.
`String`	`getHost()` Matches the hostname from a request URL.
`String`	`getHTTPMethod()` Matches the HTTP method of a request.
`Integer`	`getPriority()` The priority of the sampling rule.
`Integer`	`getReservoirSize()` A fixed number of matching requests to instrument per second, prior to applying the fixed rate.
`String`	`getResourceARN()` Matches the ARN of the Amazon Web Services resource on which the service runs.
`String`	`getRuleARN()` The ARN of the sampling rule.
`String`	`getRuleName()` The name of the sampling rule.
`String`	`getServiceName()` Matches the `name` that the service uses to identify itself in segments.
`String`	`getServiceType()` Matches the `origin` that the service uses to identify its type in segments.
`String`	`getURLPath()` Matches the path from a request URL.
`Integer`	`getVersion()` The version of the sampling rule format (`1`).
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttributes(Map<String,String> attributes)` Matches attributes derived from the request.
`void`	`setFixedRate(Double fixedRate)` The percentage of matching requests to instrument, after the reservoir is exhausted.
`void`	`setHost(String host)` Matches the hostname from a request URL.
`void`	`setHTTPMethod(String hTTPMethod)` Matches the HTTP method of a request.
`void`	`setPriority(Integer priority)` The priority of the sampling rule.
`void`	`setReservoirSize(Integer reservoirSize)` A fixed number of matching requests to instrument per second, prior to applying the fixed rate.
`void`	`setResourceARN(String resourceARN)` Matches the ARN of the Amazon Web Services resource on which the service runs.
`void`	`setRuleARN(String ruleARN)` The ARN of the sampling rule.
`void`	`setRuleName(String ruleName)` The name of the sampling rule.
`void`	`setServiceName(String serviceName)` Matches the `name` that the service uses to identify itself in segments.
`void`	`setServiceType(String serviceType)` Matches the `origin` that the service uses to identify its type in segments.
`void`	`setURLPath(String uRLPath)` Matches the path from a request URL.
`void`	`setVersion(Integer version)` The version of the sampling rule format (`1`).
`String`	`toString()` Returns a string representation of this object.
`SamplingRule`	`withAttributes(Map<String,String> attributes)` Matches attributes derived from the request.
`SamplingRule`	`withFixedRate(Double fixedRate)` The percentage of matching requests to instrument, after the reservoir is exhausted.
`SamplingRule`	`withHost(String host)` Matches the hostname from a request URL.
`SamplingRule`	`withHTTPMethod(String hTTPMethod)` Matches the HTTP method of a request.
`SamplingRule`	`withPriority(Integer priority)` The priority of the sampling rule.
`SamplingRule`	`withReservoirSize(Integer reservoirSize)` A fixed number of matching requests to instrument per second, prior to applying the fixed rate.
`SamplingRule`	`withResourceARN(String resourceARN)` Matches the ARN of the Amazon Web Services resource on which the service runs.
`SamplingRule`	`withRuleARN(String ruleARN)` The ARN of the sampling rule.
`SamplingRule`	`withRuleName(String ruleName)` The name of the sampling rule.
`SamplingRule`	`withServiceName(String serviceName)` Matches the `name` that the service uses to identify itself in segments.
`SamplingRule`	`withServiceType(String serviceType)` Matches the `origin` that the service uses to identify its type in segments.
`SamplingRule`	`withURLPath(String uRLPath)` Matches the path from a request URL.
`SamplingRule`	`withVersion(Integer version)` The version of the sampling rule format (`1`).

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SamplingRule
```
public SamplingRule()
```
- Method Detail
  - setRuleName
```
public void setRuleName(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.
  - getRuleName
```
public String getRuleName()
```
    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.
  - withRuleName
```
public SamplingRule withRuleName(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.
  - setRuleARN
```
public void setRuleARN(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.
  - getRuleARN
```
public String getRuleARN()
```
    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.
  - withRuleARN
```
public SamplingRule withRuleARN(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.
  - setResourceARN
```
public void setResourceARN(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.
  - getResourceARN
```
public String getResourceARN()
```
    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.
  - withResourceARN
```
public SamplingRule withResourceARN(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.
  - setPriority
```
public void setPriority(Integer priority)
```
    The priority of the sampling rule.
    
    Parameters:
    
    priority - The priority of the sampling rule.
  - getPriority
```
public Integer getPriority()
```
    The priority of the sampling rule.
    
    Returns:
    
    The priority of the sampling rule.
  - withPriority
```
public SamplingRule withPriority(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.
  - setFixedRate
```
public void setFixedRate(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.
  - getFixedRate
```
public Double getFixedRate()
```
    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.
  - withFixedRate
```
public SamplingRule withFixedRate(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.
  - setReservoirSize
```
public void setReservoirSize(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.
  - getReservoirSize
```
public Integer getReservoirSize()
```
    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.
  - withReservoirSize
```
public SamplingRule withReservoirSize(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.
  - setServiceName
```
public void setServiceName(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.
  - getServiceName
```
public String getServiceName()
```
    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.
  - withServiceName
```
public SamplingRule withServiceName(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.
  - setServiceType
```
public void setServiceType(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.
  - getServiceType
```
public String getServiceType()
```
    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.
  - withServiceType
```
public SamplingRule withServiceType(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.
  - setHost
```
public void setHost(String host)
```
    Matches the hostname from a request URL.
    
    Parameters:
    
    host - Matches the hostname from a request URL.
  - getHost
```
public String getHost()
```
    Matches the hostname from a request URL.
    
    Returns:
    
    Matches the hostname from a request URL.
  - withHost
```
public SamplingRule withHost(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.
  - setHTTPMethod
```
public void setHTTPMethod(String hTTPMethod)
```
    Matches the HTTP method of a request.
    
    Parameters:
    
    hTTPMethod - Matches the HTTP method of a request.
  - getHTTPMethod
```
public String getHTTPMethod()
```
    Matches the HTTP method of a request.
    
    Returns:
    
    Matches the HTTP method of a request.
  - withHTTPMethod
```
public SamplingRule withHTTPMethod(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.
  - setURLPath
```
public void setURLPath(String uRLPath)
```
    Matches the path from a request URL.
    
    Parameters:
    
    uRLPath - Matches the path from a request URL.
  - getURLPath
```
public String getURLPath()
```
    Matches the path from a request URL.
    
    Returns:
    
    Matches the path from a request URL.
  - withURLPath
```
public SamplingRule withURLPath(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.
  - setVersion
```
public void setVersion(Integer version)
```
    The version of the sampling rule format (1).
    
    Parameters:
    
    version - The version of the sampling rule format (1).
  - getVersion
```
public Integer getVersion()
```
    The version of the sampling rule format (1).
    
    Returns:
    
    The version of the sampling rule format (1).
  - withVersion
```
public SamplingRule withVersion(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.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Matches attributes derived from the request.
    
    Returns:
    
    Matches attributes derived from the request.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    Matches attributes derived from the request.
    
    Parameters:
    
    attributes - Matches attributes derived from the request.
  - withAttributes
```
public SamplingRule withAttributes(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.
  - addAttributesEntry
```
public SamplingRule addAttributesEntry(String key,
                                       String value)
```
    Add a single Attributes entry
    
    See Also:
    
    withAttributes(java.util.Map<java.lang.String, java.lang.String>)
  - clearAttributesEntries
```
public SamplingRule clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SamplingRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.639

Class SamplingRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SamplingRule

Method Detail

setRuleName

getRuleName

withRuleName

setRuleARN

getRuleARN

withRuleARN

setResourceARN

getResourceARN

withResourceARN

setPriority

getPriority

withPriority

setFixedRate

getFixedRate

withFixedRate

setReservoirSize

getReservoirSize

withReservoirSize

setServiceName

getServiceName

withServiceName

setServiceType

getServiceType

withServiceType

setHost

getHost

withHost

setHTTPMethod

getHTTPMethod

withHTTPMethod

setURLPath

getURLPath

withURLPath

setVersion

getVersion

withVersion

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

toString

equals

hashCode

clone

marshall