Interface ScopeConfig

All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
ScopeConfig.BuilderBase.ScopeConfigImpl
@Deprecated(forRemoval=true, since="27.0.0") public interface ScopeConfig 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.
Scope configuration retained for compatibility; core metrics ignores its settings.
See Also:

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static ScopeConfig.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 ScopeConfig.Builder
    builder(ScopeConfig 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 ScopeConfig
    create(Config config)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new instance from configuration.
    boolean
    enabled()
    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.
    Optional<Pattern>
    exclude()
    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.
    Optional<Pattern>
    include()
    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.
    default boolean
    isMeterEnabled(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics does not apply scope filtering, and this method will be removed.
    String
    name()
    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.

  • Method Details

    • builder

      static ScopeConfig.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 ScopeConfig.Builder builder(ScopeConfig 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 ScopeConfig 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

    • isMeterEnabled

      @Deprecated(forRemoval=true, since="27.0.0") default boolean isMeterEnabled(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics does not apply scope filtering, and this method will be removed.
      Always returns true because core metrics does not apply scope filtering.
      Parameters:
      name - ignored; must not be null
      Returns:
      true

    • name

      @Deprecated(since="27.0.0", forRemoval=true) String name()
      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 name.
      Returns:
      configured scope name

    • enabled

      @Deprecated(since="27.0.0", forRemoval=true) boolean enabled()
      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 whether the scope is configured as enabled.
      Returns:
      configured value

    • include

      @Deprecated(since="27.0.0", forRemoval=true) Optional<Pattern> include()
      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 meter-name inclusion pattern.
      Returns:
      configured inclusion pattern

    • exclude

      @Deprecated(since="27.0.0", forRemoval=true) Optional<Pattern> exclude()
      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 meter-name exclusion pattern.
      Returns:
      configured exclusion pattern