SamplingRule (AWS Java SDK :: Services :: AWS X-Ray 2.20.101 API)

java.lang.Object
- software.amazon.awssdk.services.xray.model.SamplingRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SamplingRule.Builder,SamplingRule>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class SamplingRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SamplingRule.Builder,SamplingRule>
```
A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SamplingRule.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SamplingRule.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`attributes()` Matches attributes derived from the request.
`static SamplingRule.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)`
`boolean`	`hasAttributes()` For responses, this returns true if the service returned a value for the Attributes property.
`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 Amazon Web Services 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 SamplingRule.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.
`SamplingRule.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`urlPath()` Matches the path from a request URL.
`Integer`	`version()` The version of the sampling rule format (`1`).

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. 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 final 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 final String resourceARN()
```
    Matches the ARN of the Amazon Web Services resource on which the service runs.
    
    Returns:
    
    Matches the ARN of the Amazon Web Services resource on which the service runs.
  - priority
```
public final Integer priority()
```
    The priority of the sampling rule.
    
    Returns:
    
    The priority 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.
  - reservoirSize
```
public final 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.
  - serviceName
```
public final 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 final 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.
  - host
```
public final String host()
```
    Matches the hostname from a request URL.
    
    Returns:
    
    Matches the hostname from a request URL.
  - httpMethod
```
public final String httpMethod()
```
    Matches the HTTP method of a request.
    
    Returns:
    
    Matches the HTTP method of a request.
  - urlPath
```
public final String urlPath()
```
    Matches the path from a request URL.
    
    Returns:
    
    Matches the path from a request URL.
  - version
```
public final Integer version()
```
    The version of the sampling rule format (1).
    
    Returns:
    
    The version of the sampling rule format (1).
  - hasAttributes
```
public final boolean hasAttributes()
```
    For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - attributes
```
public final Map<String,String> attributes()
```
    Matches attributes derived from the request.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.
    
    Returns:
    
    Matches attributes derived from the request.
  - toBuilder
```
public SamplingRule.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SamplingRule.Builder,SamplingRule>
  - builder
```
public static SamplingRule.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SamplingRule.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

Class SamplingRule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

ruleName

ruleARN

resourceARN

priority

fixedRate

reservoirSize

serviceName

serviceType

host

httpMethod

urlPath

version

hasAttributes

attributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields