AWS SDK for C++  1.9.66
AWS SDK for C++
Public Member Functions | List of all members
Aws::XRay::Model::SamplingTargetDocument Class Reference

#include <SamplingTargetDocument.h>

Public Member Functions

 SamplingTargetDocument ()
 
 SamplingTargetDocument (Aws::Utils::Json::JsonView jsonValue)
 
SamplingTargetDocumentoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetRuleName () const
 
bool RuleNameHasBeenSet () const
 
void SetRuleName (const Aws::String &value)
 
void SetRuleName (Aws::String &&value)
 
void SetRuleName (const char *value)
 
SamplingTargetDocumentWithRuleName (const Aws::String &value)
 
SamplingTargetDocumentWithRuleName (Aws::String &&value)
 
SamplingTargetDocumentWithRuleName (const char *value)
 
double GetFixedRate () const
 
bool FixedRateHasBeenSet () const
 
void SetFixedRate (double value)
 
SamplingTargetDocumentWithFixedRate (double value)
 
int GetReservoirQuota () const
 
bool ReservoirQuotaHasBeenSet () const
 
void SetReservoirQuota (int value)
 
SamplingTargetDocumentWithReservoirQuota (int value)
 
const Aws::Utils::DateTimeGetReservoirQuotaTTL () const
 
bool ReservoirQuotaTTLHasBeenSet () const
 
void SetReservoirQuotaTTL (const Aws::Utils::DateTime &value)
 
void SetReservoirQuotaTTL (Aws::Utils::DateTime &&value)
 
SamplingTargetDocumentWithReservoirQuotaTTL (const Aws::Utils::DateTime &value)
 
SamplingTargetDocumentWithReservoirQuotaTTL (Aws::Utils::DateTime &&value)
 
int GetInterval () const
 
bool IntervalHasBeenSet () const
 
void SetInterval (int value)
 
SamplingTargetDocumentWithInterval (int value)
 

Detailed Description

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 Reference

Definition at line 35 of file SamplingTargetDocument.h.

Constructor & Destructor Documentation

◆ SamplingTargetDocument() [1/2]

Aws::XRay::Model::SamplingTargetDocument::SamplingTargetDocument ( )

◆ SamplingTargetDocument() [2/2]

Aws::XRay::Model::SamplingTargetDocument::SamplingTargetDocument ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ FixedRateHasBeenSet()

bool Aws::XRay::Model::SamplingTargetDocument::FixedRateHasBeenSet ( ) const
inline

The percentage of matching requests to instrument, after the reservoir is exhausted.

Definition at line 95 of file SamplingTargetDocument.h.

◆ GetFixedRate()

double Aws::XRay::Model::SamplingTargetDocument::GetFixedRate ( ) const
inline

The percentage of matching requests to instrument, after the reservoir is exhausted.

Definition at line 89 of file SamplingTargetDocument.h.

◆ GetInterval()

int Aws::XRay::Model::SamplingTargetDocument::GetInterval ( ) const
inline

The number of seconds for the service to wait before getting sampling targets again.

Definition at line 166 of file SamplingTargetDocument.h.

◆ GetReservoirQuota()

int Aws::XRay::Model::SamplingTargetDocument::GetReservoirQuota ( ) const
inline

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

Definition at line 113 of file SamplingTargetDocument.h.

◆ GetReservoirQuotaTTL()

const Aws::Utils::DateTime& Aws::XRay::Model::SamplingTargetDocument::GetReservoirQuotaTTL ( ) const
inline

When the reservoir quota expires.

Definition at line 134 of file SamplingTargetDocument.h.

◆ GetRuleName()

const Aws::String& Aws::XRay::Model::SamplingTargetDocument::GetRuleName ( ) const
inline

The name of the sampling rule.

Definition at line 47 of file SamplingTargetDocument.h.

◆ IntervalHasBeenSet()

bool Aws::XRay::Model::SamplingTargetDocument::IntervalHasBeenSet ( ) const
inline

The number of seconds for the service to wait before getting sampling targets again.

Definition at line 172 of file SamplingTargetDocument.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::XRay::Model::SamplingTargetDocument::Jsonize ( ) const

◆ operator=()

SamplingTargetDocument& Aws::XRay::Model::SamplingTargetDocument::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ReservoirQuotaHasBeenSet()

bool Aws::XRay::Model::SamplingTargetDocument::ReservoirQuotaHasBeenSet ( ) const
inline

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

Definition at line 118 of file SamplingTargetDocument.h.

◆ ReservoirQuotaTTLHasBeenSet()

bool Aws::XRay::Model::SamplingTargetDocument::ReservoirQuotaTTLHasBeenSet ( ) const
inline

When the reservoir quota expires.

Definition at line 139 of file SamplingTargetDocument.h.

◆ RuleNameHasBeenSet()

bool Aws::XRay::Model::SamplingTargetDocument::RuleNameHasBeenSet ( ) const
inline

The name of the sampling rule.

Definition at line 52 of file SamplingTargetDocument.h.

◆ SetFixedRate()

void Aws::XRay::Model::SamplingTargetDocument::SetFixedRate ( double  value)
inline

The percentage of matching requests to instrument, after the reservoir is exhausted.

Definition at line 101 of file SamplingTargetDocument.h.

◆ SetInterval()

void Aws::XRay::Model::SamplingTargetDocument::SetInterval ( int  value)
inline

The number of seconds for the service to wait before getting sampling targets again.

Definition at line 178 of file SamplingTargetDocument.h.

◆ SetReservoirQuota()

void Aws::XRay::Model::SamplingTargetDocument::SetReservoirQuota ( int  value)
inline

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

Definition at line 123 of file SamplingTargetDocument.h.

◆ SetReservoirQuotaTTL() [1/2]

void Aws::XRay::Model::SamplingTargetDocument::SetReservoirQuotaTTL ( Aws::Utils::DateTime &&  value)
inline

When the reservoir quota expires.

Definition at line 149 of file SamplingTargetDocument.h.

◆ SetReservoirQuotaTTL() [2/2]

void Aws::XRay::Model::SamplingTargetDocument::SetReservoirQuotaTTL ( const Aws::Utils::DateTime value)
inline

When the reservoir quota expires.

Definition at line 144 of file SamplingTargetDocument.h.

◆ SetRuleName() [1/3]

void Aws::XRay::Model::SamplingTargetDocument::SetRuleName ( Aws::String &&  value)
inline

The name of the sampling rule.

Definition at line 62 of file SamplingTargetDocument.h.

◆ SetRuleName() [2/3]

void Aws::XRay::Model::SamplingTargetDocument::SetRuleName ( const Aws::String value)
inline

The name of the sampling rule.

Definition at line 57 of file SamplingTargetDocument.h.

◆ SetRuleName() [3/3]

void Aws::XRay::Model::SamplingTargetDocument::SetRuleName ( const char *  value)
inline

The name of the sampling rule.

Definition at line 67 of file SamplingTargetDocument.h.

◆ WithFixedRate()

SamplingTargetDocument& Aws::XRay::Model::SamplingTargetDocument::WithFixedRate ( double  value)
inline

The percentage of matching requests to instrument, after the reservoir is exhausted.

Definition at line 107 of file SamplingTargetDocument.h.

◆ WithInterval()

SamplingTargetDocument& Aws::XRay::Model::SamplingTargetDocument::WithInterval ( int  value)
inline

The number of seconds for the service to wait before getting sampling targets again.

Definition at line 184 of file SamplingTargetDocument.h.

◆ WithReservoirQuota()

SamplingTargetDocument& Aws::XRay::Model::SamplingTargetDocument::WithReservoirQuota ( int  value)
inline

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

Definition at line 128 of file SamplingTargetDocument.h.

◆ WithReservoirQuotaTTL() [1/2]

SamplingTargetDocument& Aws::XRay::Model::SamplingTargetDocument::WithReservoirQuotaTTL ( Aws::Utils::DateTime &&  value)
inline

When the reservoir quota expires.

Definition at line 159 of file SamplingTargetDocument.h.

◆ WithReservoirQuotaTTL() [2/2]

SamplingTargetDocument& Aws::XRay::Model::SamplingTargetDocument::WithReservoirQuotaTTL ( const Aws::Utils::DateTime value)
inline

When the reservoir quota expires.

Definition at line 154 of file SamplingTargetDocument.h.

◆ WithRuleName() [1/3]

SamplingTargetDocument& Aws::XRay::Model::SamplingTargetDocument::WithRuleName ( Aws::String &&  value)
inline

The name of the sampling rule.

Definition at line 77 of file SamplingTargetDocument.h.

◆ WithRuleName() [2/3]

SamplingTargetDocument& Aws::XRay::Model::SamplingTargetDocument::WithRuleName ( const Aws::String value)
inline

The name of the sampling rule.

Definition at line 72 of file SamplingTargetDocument.h.

◆ WithRuleName() [3/3]

SamplingTargetDocument& Aws::XRay::Model::SamplingTargetDocument::WithRuleName ( const char *  value)
inline

The name of the sampling rule.

Definition at line 82 of file SamplingTargetDocument.h.


The documentation for this class was generated from the following file: