SamplingStatisticsDocument (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SamplingStatisticsDocument
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to GetSamplingTargets.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SamplingStatisticsDocument()

Constructors
Constructor and Description
`SamplingStatisticsDocument()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SamplingStatisticsDocument`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBorrowCount()` The number of requests recorded with borrowed reservoir quota.
`String`	`getClientID()` A unique identifier for the service in hexadecimal.
`Integer`	`getRequestCount()` The number of requests that matched the rule.
`String`	`getRuleName()` The name of the sampling rule.
`Integer`	`getSampledCount()` The number of requests recorded.
`Date`	`getTimestamp()` The current time.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBorrowCount(Integer borrowCount)` The number of requests recorded with borrowed reservoir quota.
`void`	`setClientID(String clientID)` A unique identifier for the service in hexadecimal.
`void`	`setRequestCount(Integer requestCount)` The number of requests that matched the rule.
`void`	`setRuleName(String ruleName)` The name of the sampling rule.
`void`	`setSampledCount(Integer sampledCount)` The number of requests recorded.
`void`	`setTimestamp(Date timestamp)` The current time.
`String`	`toString()` Returns a string representation of this object.
`SamplingStatisticsDocument`	`withBorrowCount(Integer borrowCount)` The number of requests recorded with borrowed reservoir quota.
`SamplingStatisticsDocument`	`withClientID(String clientID)` A unique identifier for the service in hexadecimal.
`SamplingStatisticsDocument`	`withRequestCount(Integer requestCount)` The number of requests that matched the rule.
`SamplingStatisticsDocument`	`withRuleName(String ruleName)` The name of the sampling rule.
`SamplingStatisticsDocument`	`withSampledCount(Integer sampledCount)` The number of requests recorded.
`SamplingStatisticsDocument`	`withTimestamp(Date timestamp)` The current time.

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

- Constructor Detail
  - SamplingStatisticsDocument
```
public SamplingStatisticsDocument()
```
- Method Detail
  - setRuleName
```
public void setRuleName(String ruleName)
```
    The name of the sampling rule.
    
    Parameters:
    
    ruleName - The name of the sampling rule.
  - getRuleName
```
public String getRuleName()
```
    The name of the sampling rule.
    
    Returns:
    
    The name of the sampling rule.
  - withRuleName
```
public SamplingStatisticsDocument withRuleName(String ruleName)
```
    The name of the sampling rule.
    
    Parameters:
    
    ruleName - The name of the sampling rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientID
```
public void setClientID(String clientID)
```
    A unique identifier for the service in hexadecimal.
    
    Parameters:
    
    clientID - A unique identifier for the service in hexadecimal.
  - getClientID
```
public String getClientID()
```
    A unique identifier for the service in hexadecimal.
    
    Returns:
    
    A unique identifier for the service in hexadecimal.
  - withClientID
```
public SamplingStatisticsDocument withClientID(String clientID)
```
    A unique identifier for the service in hexadecimal.
    
    Parameters:
    
    clientID - A unique identifier for the service in hexadecimal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimestamp
```
public void setTimestamp(Date timestamp)
```
    The current time.
    
    Parameters:
    
    timestamp - The current time.
  - getTimestamp
```
public Date getTimestamp()
```
    The current time.
    
    Returns:
    
    The current time.
  - withTimestamp
```
public SamplingStatisticsDocument withTimestamp(Date timestamp)
```
    The current time.
    
    Parameters:
    
    timestamp - The current time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRequestCount
```
public void setRequestCount(Integer requestCount)
```
    The number of requests that matched the rule.
    
    Parameters:
    
    requestCount - The number of requests that matched the rule.
  - getRequestCount
```
public Integer getRequestCount()
```
    The number of requests that matched the rule.
    
    Returns:
    
    The number of requests that matched the rule.
  - withRequestCount
```
public SamplingStatisticsDocument withRequestCount(Integer requestCount)
```
    The number of requests that matched the rule.
    
    Parameters:
    
    requestCount - The number of requests that matched the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSampledCount
```
public void setSampledCount(Integer sampledCount)
```
    The number of requests recorded.
    
    Parameters:
    
    sampledCount - The number of requests recorded.
  - getSampledCount
```
public Integer getSampledCount()
```
    The number of requests recorded.
    
    Returns:
    
    The number of requests recorded.
  - withSampledCount
```
public SamplingStatisticsDocument withSampledCount(Integer sampledCount)
```
    The number of requests recorded.
    
    Parameters:
    
    sampledCount - The number of requests recorded.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBorrowCount
```
public void setBorrowCount(Integer borrowCount)
```
    The number of requests recorded with borrowed reservoir quota.
    
    Parameters:
    
    borrowCount - The number of requests recorded with borrowed reservoir quota.
  - getBorrowCount
```
public Integer getBorrowCount()
```
    The number of requests recorded with borrowed reservoir quota.
    
    Returns:
    
    The number of requests recorded with borrowed reservoir quota.
  - withBorrowCount
```
public SamplingStatisticsDocument withBorrowCount(Integer borrowCount)
```
    The number of requests recorded with borrowed reservoir quota.
    
    Parameters:
    
    borrowCount - The number of requests recorded with borrowed reservoir quota.
    
    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 SamplingStatisticsDocument 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.

Did this page help you?

Class SamplingStatisticsDocument

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SamplingStatisticsDocument

Method Detail

setRuleName

getRuleName

withRuleName

setClientID

getClientID

withClientID

setTimestamp

getTimestamp

withTimestamp

setRequestCount

getRequestCount

withRequestCount

setSampledCount

getSampledCount

withSampledCount

setBorrowCount

getBorrowCount

withBorrowCount

toString

equals

hashCode

clone

marshall