Interface ScopingConfig

All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
ScopingConfig.BuilderBase.ScopingConfigImpl
@Deprecated(forRemoval=true, since="27.0.0") public interface ScopingConfig extends Prototype.Api
Deprecated, for removal: This API element is subject to removal in a future version.
Core metrics ignores these settings, and this type will be removed.
Scoping configuration retained for compatibility; core metrics ignores its settings.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    ScopingConfig.Builder
    Deprecated, for removal: This API element is subject to removal in a future version.
    Fluent API builder for ScopingConfig.
    static class 
    ScopingConfig.BuilderBase<BUILDER extends ScopingConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends ScopingConfig>
    Deprecated, for removal: This API element is subject to removal in a future version.
    Fluent API builder base for ScopingConfig.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    SCOPE_TAG_NAME_DEFAULT
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores scope tag names, and this constant will be removed.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ScopingConfig.Builder
    builder()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new fluent API builder to customize configuration.
    static ScopingConfig.Builder
    builder(ScopingConfig instance)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new fluent API builder from an existing instance.
    static ScopingConfig
    create()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new instance with default values.
    static ScopingConfig
    create(Config config)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new instance from configuration.
    Optional<String>
    defaultValue()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.
    Map<String, ScopeConfig>
    scopes()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores these settings, and this method will be removed.
    Optional<String>
    tagName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores this value, and this method will be removed.

  • Field Details

    • SCOPE_TAG_NAME_DEFAULT

      @Deprecated(forRemoval=true, since="27.0.0") static final String SCOPE_TAG_NAME_DEFAULT
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores scope tag names, and this constant will be removed.
      Legacy scope tag name retained for compatibility.
      See Also:

  • Method Details

    • builder

      static ScopingConfig.Builder builder()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static ScopingConfig.Builder builder(ScopingConfig instance)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static ScopingConfig create(Config config)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      static ScopingConfig create()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new instance with default values.
      Returns:
      a new instance

    • defaultValue

      @Deprecated(since="27.0.0", forRemoval=true) Optional<String> defaultValue()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Returns the configured default scope value.
      Returns:
      configured default scope value

    • tagName

      @Deprecated(since="27.0.0", forRemoval=true) Optional<String> tagName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores this value, and this method will be removed.
      Returns the configured scope tag name.
      Returns:
      configured scope tag name

    • scopes

      @Deprecated(since="27.0.0", forRemoval=true) Map<String, ScopeConfig> scopes()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics ignores these settings, and this method will be removed.
      Returns the configured settings for individual scopes.
      Returns:
      configured scope settings