NVIDIA DeepStream SDK API Reference

9.2 Release
sdk::instrumentationscope::ScopeConfigurator< T >::Builder Class Reference

Detailed Description

template<typename T>
class sdk::instrumentationscope::ScopeConfigurator< T >::Builder

A builder class for the ScopeConfigurator that facilitates the creation of ScopeConfigurators.

Definition at line 26 of file includes/opentelemetry/sdk/instrumentationscope/scope_configurator.h.

Public Member Functions

 Builder (T default_scope_config) noexcept
 Constructor for a builder object that cam be used to create a scope configurator. More...
 
Builder & AddCondition (std::function< bool(const InstrumentationScope &)> scope_matcher, T scope_config)
 Allows the user to pass a generic function that evaluates an instrumentation scope through a boolean check. More...
 
Builder & AddConditionNameEquals (nostd::string_view scope_name, T scope_config)
 A convenience condition that specifically matches the scope name of the scope being evaluated. More...
 
ScopeConfigurator< T > Build () const
 Constructs the scope configurator object that can be used to retrieve scope config depending on the instrumentation scope. More...
 
 Builder (T default_scope_config) noexcept
 Constructor for a builder object that cam be used to create a scope configurator. More...
 
Builder & AddCondition (std::function< bool(const InstrumentationScope &)> scope_matcher, T scope_config)
 Allows the user to pass a generic function that evaluates an instrumentation scope through a boolean check. More...
 
Builder & AddConditionNameEquals (nostd::string_view scope_name, T scope_config)
 A convenience condition that specifically matches the scope name of the scope being evaluated. More...
 
ScopeConfigurator< T > Build () const
 Constructs the scope configurator object that can be used to retrieve scope config depending on the instrumentation scope. More...
 

Constructor & Destructor Documentation

◆ Builder() [1/2]

template<typename T >
sdk::instrumentationscope::ScopeConfigurator< T >::Builder::Builder ( T  default_scope_config)
inlineexplicitnoexcept

Constructor for a builder object that cam be used to create a scope configurator.

A minimally configured builder would build a ScopeConfigurator that applies the default_scope_config to every instrumentation scope.

Parameters
default_scope_configThe default scope config that the built configurator should fall back on.

Definition at line 36 of file includes/opentelemetry/sdk/instrumentationscope/scope_configurator.h.

◆ Builder() [2/2]

template<typename T >
sdk::instrumentationscope::ScopeConfigurator< T >::Builder::Builder ( T  default_scope_config)
inlineexplicitnoexcept

Constructor for a builder object that cam be used to create a scope configurator.

A minimally configured builder would build a ScopeConfigurator that applies the default_scope_config to every instrumentation scope.

Parameters
default_scope_configThe default scope config that the built configurator should fall back on.

Definition at line 36 of file 9.2/includes/opentelemetry/sdk/instrumentationscope/scope_configurator.h.

Member Function Documentation

◆ AddCondition() [1/2]

template<typename T >
Builder& sdk::instrumentationscope::ScopeConfigurator< T >::Builder::AddCondition ( std::function< bool(const InstrumentationScope &)>  scope_matcher,
T  scope_config 
)
inline

Allows the user to pass a generic function that evaluates an instrumentation scope through a boolean check.

If the check passes, the provided config is applied. Conditions are evaluated in order.

Parameters
scope_matchera function that returns true if the scope being evaluated matches the criteria defined by the function.
scope_configthe scope configuration to return for the matched scope.
Returns
this

Definition at line 48 of file includes/opentelemetry/sdk/instrumentationscope/scope_configurator.h.

◆ AddCondition() [2/2]

template<typename T >
Builder& sdk::instrumentationscope::ScopeConfigurator< T >::Builder::AddCondition ( std::function< bool(const InstrumentationScope &)>  scope_matcher,
T  scope_config 
)
inline

Allows the user to pass a generic function that evaluates an instrumentation scope through a boolean check.

If the check passes, the provided config is applied. Conditions are evaluated in order.

Parameters
scope_matchera function that returns true if the scope being evaluated matches the criteria defined by the function.
scope_configthe scope configuration to return for the matched scope.
Returns
this

Definition at line 48 of file 9.2/includes/opentelemetry/sdk/instrumentationscope/scope_configurator.h.

◆ AddConditionNameEquals() [1/2]

template<typename T >
Builder& sdk::instrumentationscope::ScopeConfigurator< T >::Builder::AddConditionNameEquals ( nostd::string_view  scope_name,
T  scope_config 
)
inline

A convenience condition that specifically matches the scope name of the scope being evaluated.

If the scope name matches to the provided string, then the provided scope configuration is applied to the scope.

Parameters
scope_nameThe scope name to which the config needs to be applied.
scope_configThe scope config for the matching scopes.
Returns
this

Definition at line 63 of file 9.2/includes/opentelemetry/sdk/instrumentationscope/scope_configurator.h.

◆ AddConditionNameEquals() [2/2]

template<typename T >
Builder& sdk::instrumentationscope::ScopeConfigurator< T >::Builder::AddConditionNameEquals ( nostd::string_view  scope_name,
T  scope_config 
)
inline

A convenience condition that specifically matches the scope name of the scope being evaluated.

If the scope name matches to the provided string, then the provided scope configuration is applied to the scope.

Parameters
scope_nameThe scope name to which the config needs to be applied.
scope_configThe scope config for the matching scopes.
Returns
this

Definition at line 63 of file includes/opentelemetry/sdk/instrumentationscope/scope_configurator.h.

◆ Build() [1/2]

template<typename T >
ScopeConfigurator<T> sdk::instrumentationscope::ScopeConfigurator< T >::Builder::Build ( ) const
inline

Constructs the scope configurator object that can be used to retrieve scope config depending on the instrumentation scope.

Returns
a configured scope configurator.

Definition at line 78 of file includes/opentelemetry/sdk/instrumentationscope/scope_configurator.h.

◆ Build() [2/2]

template<typename T >
ScopeConfigurator<T> sdk::instrumentationscope::ScopeConfigurator< T >::Builder::Build ( ) const
inline

Constructs the scope configurator object that can be used to retrieve scope config depending on the instrumentation scope.

Returns
a configured scope configurator.

Definition at line 78 of file 9.2/includes/opentelemetry/sdk/instrumentationscope/scope_configurator.h.


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