software.amazon.awssdk.services.xray.model

Class SamplingTargetDocument

java.lang.Object

software.amazon.awssdk.services.xray.model.SamplingTargetDocument

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SamplingTargetDocument.Builder,SamplingTargetDocument>

@Generated(value="software.amazon.awssdk:codegen")
public final class SamplingTargetDocument
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SamplingTargetDocument.Builder,SamplingTargetDocument>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SamplingTargetDocument.Builder

Method Summary

Modifier and Type	Method and Description
static SamplingTargetDocument.Builder	builder()
boolean	equals(Object obj)
Double	fixedRate() The percentage of matching requests to instrument, after the reservoir is exhausted.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	interval() The number of seconds for the service to wait before getting sampling targets again.
Integer	reservoirQuota() The number of requests per second that X-Ray allocated this service.
Instant	reservoirQuotaTTL() When the reservoir quota expires.
String	ruleName() The name of the sampling rule.
List<SdkField<?>>	sdkFields()
static Class<? extends SamplingTargetDocument.Builder>	serializableBuilderClass()
SamplingTargetDocument.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

ruleName

public String ruleName()

The name of the sampling rule.

Returns:

The name of the sampling rule.

fixedRate

public Double fixedRate()

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.

reservoirQuota

public Integer reservoirQuota()

The number of requests per second that X-Ray allocated this service.

Returns:

The number of requests per second that X-Ray allocated this service.

reservoirQuotaTTL

public Instant reservoirQuotaTTL()

When the reservoir quota expires.

Returns:

When the reservoir quota expires.

interval

public Integer interval()

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.

toBuilder

public SamplingTargetDocument.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SamplingTargetDocument.Builder,SamplingTargetDocument>

Returns:

a builder for type T

builder

public static SamplingTargetDocument.Builder builder()

serializableBuilderClass

public static Class<? extends SamplingTargetDocument.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.