software.amazon.awssdk.services.xray.model

Class SamplingRuleUpdate

java.lang.Object

software.amazon.awssdk.services.xray.model.SamplingRuleUpdate

All Implemented Interfaces:

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

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

A document specifying changes to a sampling rule's configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SamplingRuleUpdate.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	attributes() Matches attributes derived from the request.
static SamplingRuleUpdate.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()
String	host() Matches the hostname from a request URL.
String	httpMethod() Matches the HTTP method of a request.
Integer	priority() The priority of the sampling rule.
Integer	reservoirSize() A fixed number of matching requests to instrument per second, prior to applying the fixed rate.
String	resourceARN() Matches the ARN of the AWS resource on which the service runs.
String	ruleARN() The ARN of the sampling rule.
String	ruleName() The name of the sampling rule.
List<SdkField<?>>	sdkFields()
static Class<? extends SamplingRuleUpdate.Builder>	serializableBuilderClass()
String	serviceName() Matches the name that the service uses to identify itself in segments.
String	serviceType() Matches the origin that the service uses to identify its type in segments.
SamplingRuleUpdate.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	urlPath() Matches the path from a request URL.

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. Specify a rule by either name or ARN, but not both.

Returns:

The name of the sampling rule. Specify a rule by either name or ARN, but not both.

ruleARN

public String ruleARN()

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Returns:

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

resourceARN

public String resourceARN()

Matches the ARN of the AWS resource on which the service runs.

Returns:

Matches the ARN of the AWS resource on which the service runs.

priority

public Integer priority()

The priority of the sampling rule.

Returns:

The priority 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.

reservoirSize

public Integer reservoirSize()

A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

Returns:

A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

host

public String host()

Matches the hostname from a request URL.

Returns:

Matches the hostname from a request URL.

serviceName

public String serviceName()

Matches the name that the service uses to identify itself in segments.

Returns:

Matches the name that the service uses to identify itself in segments.

serviceType

public String serviceType()

Matches the origin that the service uses to identify its type in segments.

Returns:

Matches the origin that the service uses to identify its type in segments.

httpMethod

public String httpMethod()

Matches the HTTP method of a request.

Returns:

Matches the HTTP method of a request.

urlPath

public String urlPath()

Matches the path from a request URL.

Returns:

Matches the path from a request URL.

attributes

public Map<String,String> attributes()

Matches attributes derived from the request.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Matches attributes derived from the request.

toBuilder

public SamplingRuleUpdate.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<SamplingRuleUpdate.Builder,SamplingRuleUpdate>

Returns:

a builder for type T

builder

public static SamplingRuleUpdate.Builder builder()

serializableBuilderClass

public static Class<? extends SamplingRuleUpdate.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.