Package com.amazonaws.xray.strategy.sampling

Class SamplingRequest

java.lang.Object

com.amazonaws.xray.strategy.sampling.SamplingRequest

public class SamplingRequest
extends Object

Represents the input request to the sampler. Contains attributes relevant to making sampling decisions.

Constructor Summary

Constructors

Constructor	Description
SamplingRequest(@Nullable String service, @Nullable String host, @Nullable String url, @Nullable String method, @Nullable String serviceType)
SamplingRequest(String roleArn, @Nullable String resourceArn, @Nullable String service, @Nullable String host, @Nullable String method, @Nullable String url, @Nullable String serviceType, @Nullable Map<String,String> attributes)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getAccountId()
Map<String,String>	getAttributes()
Optional<String>	getHost()
Optional<String>	getMethod()
Optional<String>	getResourceARN()
String	getRoleARN()
Optional<String>	getService()
Optional<String>	getServiceType()
Optional<String>	getUrl()
void	setServiceType(String serviceType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SamplingRequest

public SamplingRequest(String roleArn,
 @Nullable String resourceArn,
 @Nullable String service,
 @Nullable String host,
 @Nullable String method,
 @Nullable String url,
 @Nullable String serviceType,
 @Nullable Map<String,String> attributes)

Parameters:

roleArn - the role of the customer requesting a sampling decision. Must not be null.

resourceArn - the resource for which a sampling decision is being requested. Ex. "arn:aws:execute-api:us-east-1:1234566789012:qsxrty/test/GET/foo/bar/*".

service - the service name for which a sampling decision is being requested. Ex. "www.foo.com".

host - the host name extracted from the incoming request Host header.

method - the Http Method extracted from the Request-Line.

url - the URL extracted from the Request-Line.

serviceType - the service type.

attributes - list of key-value pairs generated on a per-request basis.

SamplingRequest

public SamplingRequest(@Nullable String service,
 @Nullable String host,
 @Nullable String url,
 @Nullable String method,
 @Nullable String serviceType)

Method Details

getAccountId

public Optional<String> getAccountId()

getRoleARN

public String getRoleARN()

getResourceARN

public Optional<String> getResourceARN()

getService

public Optional<String> getService()

getMethod

public Optional<String> getMethod()

getUrl

public Optional<String> getUrl()

getHost

public Optional<String> getHost()

getServiceType

public Optional<String> getServiceType()

getAttributes

public Map<String,String> getAttributes()

setServiceType

public void setServiceType(String serviceType)