SamplingTargetDocument (AWS Java SDK for AWS X-Ray 1.12.163 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SamplingTargetDocument
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SamplingTargetDocument()

Constructors
Constructor and Description
`SamplingTargetDocument()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SamplingTargetDocument`	`clone()`
`boolean`	`equals(Object obj)`
`Double`	`getFixedRate()` The percentage of matching requests to instrument, after the reservoir is exhausted.
`Integer`	`getInterval()` The number of seconds for the service to wait before getting sampling targets again.
`Integer`	`getReservoirQuota()` The number of requests per second that X-Ray allocated for this service.
`Date`	`getReservoirQuotaTTL()` When the reservoir quota expires.
`String`	`getRuleName()` The name of the sampling rule.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setFixedRate(Double fixedRate)` The percentage of matching requests to instrument, after the reservoir is exhausted.
`void`	`setInterval(Integer interval)` The number of seconds for the service to wait before getting sampling targets again.
`void`	`setReservoirQuota(Integer reservoirQuota)` The number of requests per second that X-Ray allocated for this service.
`void`	`setReservoirQuotaTTL(Date reservoirQuotaTTL)` When the reservoir quota expires.
`void`	`setRuleName(String ruleName)` The name of the sampling rule.
`String`	`toString()` Returns a string representation of this object.
`SamplingTargetDocument`	`withFixedRate(Double fixedRate)` The percentage of matching requests to instrument, after the reservoir is exhausted.
`SamplingTargetDocument`	`withInterval(Integer interval)` The number of seconds for the service to wait before getting sampling targets again.
`SamplingTargetDocument`	`withReservoirQuota(Integer reservoirQuota)` The number of requests per second that X-Ray allocated for this service.
`SamplingTargetDocument`	`withReservoirQuotaTTL(Date reservoirQuotaTTL)` When the reservoir quota expires.
`SamplingTargetDocument`	`withRuleName(String ruleName)` The name of the sampling rule.

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

- Constructor Detail
  - SamplingTargetDocument
```
public SamplingTargetDocument()
```
- 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 SamplingTargetDocument 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.
  - 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 SamplingTargetDocument 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.
  - setReservoirQuota
```
public void setReservoirQuota(Integer reservoirQuota)
```
    The number of requests per second that X-Ray allocated for this service.
    
    Parameters:
    
    reservoirQuota - The number of requests per second that X-Ray allocated for this service.
  - getReservoirQuota
```
public Integer getReservoirQuota()
```
    The number of requests per second that X-Ray allocated for this service.
    
    Returns:
    
    The number of requests per second that X-Ray allocated for this service.
  - withReservoirQuota
```
public SamplingTargetDocument withReservoirQuota(Integer reservoirQuota)
```
    The number of requests per second that X-Ray allocated for this service.
    
    Parameters:
    
    reservoirQuota - The number of requests per second that X-Ray allocated for this service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReservoirQuotaTTL
```
public void setReservoirQuotaTTL(Date reservoirQuotaTTL)
```
    When the reservoir quota expires.
    
    Parameters:
    
    reservoirQuotaTTL - When the reservoir quota expires.
  - getReservoirQuotaTTL
```
public Date getReservoirQuotaTTL()
```
    When the reservoir quota expires.
    
    Returns:
    
    When the reservoir quota expires.
  - withReservoirQuotaTTL
```
public SamplingTargetDocument withReservoirQuotaTTL(Date reservoirQuotaTTL)
```
    When the reservoir quota expires.
    
    Parameters:
    
    reservoirQuotaTTL - When the reservoir quota expires.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInterval
```
public void setInterval(Integer interval)
```
    The number of seconds for the service to wait before getting sampling targets again.
    
    Parameters:
    
    interval - The number of seconds for the service to wait before getting sampling targets again.
  - getInterval
```
public Integer getInterval()
```
    The number of seconds for the service to wait before getting sampling targets again.
    
    Returns:
    
    The number of seconds for the service to wait before getting sampling targets again.
  - withInterval
```
public SamplingTargetDocument withInterval(Integer interval)
```
    The number of seconds for the service to wait before getting sampling targets again.
    
    Parameters:
    
    interval - The number of seconds for the service to wait before getting sampling targets again.
    
    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 SamplingTargetDocument clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class SamplingTargetDocument

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SamplingTargetDocument

Method Detail

setRuleName

getRuleName

withRuleName

setFixedRate

getFixedRate

withFixedRate

setReservoirQuota

getReservoirQuota

withReservoirQuota

setReservoirQuotaTTL

getReservoirQuotaTTL

withReservoirQuotaTTL

setInterval

getInterval

withInterval

toString

equals

hashCode

clone

marshall