Package 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("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	Description
static interface	SamplingTargetDocument.Builder

Method Summary

Modifier and Type	Method	Description
static SamplingTargetDocument.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(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 for this service.
Instant	reservoirQuotaTTL()	When the reservoir quota expires.
String	ruleName()	The name of the sampling rule.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SamplingTargetDocument.Builder>	serializableBuilderClass()
SamplingTargetDocument.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

ruleName

public final String ruleName()

The name of the sampling rule.

Returns:

The name of the sampling rule.

fixedRate

public final 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 final Integer reservoirQuota()

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.

reservoirQuotaTTL

public final Instant reservoirQuotaTTL()

When the reservoir quota expires.

Returns:

When the reservoir quota expires.

interval

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<SamplingTargetDocument.Builder,SamplingTargetDocument>

builder

public static SamplingTargetDocument.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo