## Uses of Class
org.apache.ignite.mxbean.MXBeanParameter

- Packages that use MXBeanParameter
  Package | Description
  --- | ---
  org.apache.ignite.mxbean | Contains annotations for Dynamic MBeans.
  org.apache.ignite.spi.discovery.tcp | Contains default TCP/IP implementation for discovery SPI.

- - ### Uses of MXBeanParameter in org.apache.ignite.mxbean

    Method parameters in org.apache.ignite.mxbean with annotations of type MXBeanParameter
    Modifier and Type | Method and Description
    --- | ---
    `Set<String>` | ClusterMetricsMXBean.`attributeValues(String attrName)`
    `void` | ComputeMXBean.`cancel(String sesId)` Kills compute task by the session idenitifier.
    `void` | ServiceMXBean.`cancel(String name)`
    `void` | TransactionsMXBean.`cancel(String xid)` Kills transactions by the xid.
    `void` | QueryMXBean.`cancelContinuous(String originNodeId, String routineId)` Kills continuous query by the identifier.
    `void` | QueryMXBean.`cancelContinuous(String originNodeId, String routineId)` Kills continuous query by the identifier.
    `void` | QueryMXBean.`cancelScan(String originNodeId, String cacheName, Long id)` Kills scan query by the identifiers.
    `void` | QueryMXBean.`cancelScan(String originNodeId, String cacheName, Long id)` Kills scan query by the identifiers.
    `void` | QueryMXBean.`cancelScan(String originNodeId, String cacheName, Long id)` Kills scan query by the identifiers.
    `void` | SnapshotMXBean.`cancelSnapshot(String snpName)` Cancel previously started snapshot operation on the node initiator.
    `void` | QueryMXBean.`cancelSQL(String id)` Kills SQL query by the identifier.
    `void` | EncryptionMXBean.`changeCacheGroupKey(String cacheOrGrpName)` Starts cache group encryption key change process.
    `void` | EncryptionMXBean.`changeMasterKey(String masterKeyName)` Starts master key change process.
    `void` | IgniteMXBean.`clusterState(String state)` Deprecated. Use `IgniteMXBean.clusterState(String, boolean)` instead.
    `void` | IgniteMXBean.`clusterState(String state, boolean forceDeactivation)` Changes current cluster state.
    `void` | IgniteMXBean.`clusterState(String state, boolean forceDeactivation)` Changes current cluster state.
    `void` | MetricsMxBean.`configureHistogramMetric(String name, long[] bounds)` Change `HistogramMetric` configuration.
    `void` | MetricsMxBean.`configureHistogramMetric(String name, long[] bounds)` Change `HistogramMetric` configuration.
    `void` | MetricsMxBean.`configureHitRateMetric(String name, long rateTimeInterval)` Change `HitRateMetric` configuration.
    `void` | MetricsMxBean.`configureHitRateMetric(String name, long rateTimeInterval)` Change `HitRateMetric` configuration.
    `void` | SnapshotMXBean.`createSnapshot(String snpName)` Create the cluster-wide snapshot with given name asynchronously.
    `boolean` | ClientProcessorMXBean.`dropConnection(long id)` Drops client connection by `id`, if exists.
    `String` | IgniteMXBean.`executeTask(String taskName, String arg)` A shortcut method that executes given task assuming single `java.lang.String` argument and `java.lang.String` return type.
    `String` | IgniteMXBean.`executeTask(String taskName, String arg)` A shortcut method that executes given task assuming single `java.lang.String` argument and `java.lang.String` return type.
    `String` | TransactionsMXBean.`getActiveTransactions(Long minDuration, Integer minSize, String prj, String consistentIds, String xid, String lbRegex, Integer limit, String order, boolean detailed, boolean kill)`
    `String` | TransactionsMXBean.`getActiveTransactions(Long minDuration, Integer minSize, String prj, String consistentIds, String xid, String lbRegex, Integer limit, String order, boolean detailed, boolean kill)`
    `String` | TransactionsMXBean.`getActiveTransactions(Long minDuration, Integer minSize, String prj, String consistentIds, String xid, String lbRegex, Integer limit, String order, boolean detailed, boolean kill)`
    `String` | TransactionsMXBean.`getActiveTransactions(Long minDuration, Integer minSize, String prj, String consistentIds, String xid, String lbRegex, Integer limit, String order, boolean detailed, boolean kill)`
    `String` | TransactionsMXBean.`getActiveTransactions(Long minDuration, Integer minSize, String prj, String consistentIds, String xid, String lbRegex, Integer limit, String order, boolean detailed, boolean kill)`
    `String` | TransactionsMXBean.`getActiveTransactions(Long minDuration, Integer minSize, String prj, String consistentIds, String xid, String lbRegex, Integer limit, String order, boolean detailed, boolean kill)`
    `String` | TransactionsMXBean.`getActiveTransactions(Long minDuration, Integer minSize, String prj, String consistentIds, String xid, String lbRegex, Integer limit, String order, boolean detailed, boolean kill)`
    `String` | TransactionsMXBean.`getActiveTransactions(Long minDuration, Integer minSize, String prj, String consistentIds, String xid, String lbRegex, Integer limit, String order, boolean detailed, boolean kill)`
    `String` | TransactionsMXBean.`getActiveTransactions(Long minDuration, Integer minSize, String prj, String consistentIds, String xid, String lbRegex, Integer limit, String order, boolean detailed, boolean kill)`
    `String` | TransactionsMXBean.`getActiveTransactions(Long minDuration, Integer minSize, String prj, String consistentIds, String xid, String lbRegex, Integer limit, String order, boolean detailed, boolean kill)`
    `Map<String,String>` | TransactionMetricsMxBean.`getLongRunningOwnerTransactions(int duration)` Deprecated. Long running near transactions
    `String` | IgnitionMXBean.`getState(String name)` Gets state for a given grid instance.
    `Set<UUID>` | ClusterMetricsMXBean.`nodeIdsForAttribute(String attrName, String attrVal, boolean includeSrvs, boolean includeClients)`
    `Set<UUID>` | ClusterMetricsMXBean.`nodeIdsForAttribute(String attrName, String attrVal, boolean includeSrvs, boolean includeClients)`
    `Set<UUID>` | ClusterMetricsMXBean.`nodeIdsForAttribute(String attrName, String attrVal, boolean includeSrvs, boolean includeClients)`
    `Set<UUID>` | ClusterMetricsMXBean.`nodeIdsForAttribute(String attrName, String attrVal, boolean includeSrvs, boolean includeClients)`
    `boolean` | IgniteMXBean.`pingNode(String nodeId)` Pings node with given node ID to see whether it is alive.
    `boolean` | IgniteMXBean.`pingNodeByAddress(String host)` Pings node with given host name to see if it is alive.
    `void` | PersistenceMetricsMXBean.`rateTimeInterval(long rateTimeInterval)` Deprecated. Sets time interval for rate-based metrics.
    `void` | MemoryMetricsMXBean.`rateTimeInterval(long rateTimeInterval)` Deprecated. Sets time interval for `MemoryMetricsMXBean.getAllocationRate()` and `MemoryMetricsMXBean.getEvictionRate()` monitoring purposes.
    `void` | DataRegionMetricsMXBean.`rateTimeInterval(long rateTimeInterval)` Deprecated. Use `MetricsMxBean.configureHitRateMetric(String, long)` instead.
    `void` | DataStorageMetricsMXBean.`rateTimeInterval(long rateTimeInterval)` Deprecated. Use `MetricsMxBean.configureHitRateMetric(String, long)` instead.
    `boolean` | IgniteMXBean.`removeCheckpoint(String key)` This method allows manually remove the checkpoint with given `key`.
    `void` | MetricsMxBean.`resetMetrics(String registry)` Resets metrics for of a given registry.
    `void` | IgnitionMXBean.`restart(boolean cancel)` Restart JVM.
    `void` | IgniteMXBean.`runIoTest(long warmup, long duration, int threads, long maxLatency, int rangesCnt, int payLoadSize, boolean procFromNioThread)` Runs IO latency test against all remote server nodes in cluster.
    `void` | IgniteMXBean.`runIoTest(long warmup, long duration, int threads, long maxLatency, int rangesCnt, int payLoadSize, boolean procFromNioThread)` Runs IO latency test against all remote server nodes in cluster.
    `void` | IgniteMXBean.`runIoTest(long warmup, long duration, int threads, long maxLatency, int rangesCnt, int payLoadSize, boolean procFromNioThread)` Runs IO latency test against all remote server nodes in cluster.
    `void` | IgniteMXBean.`runIoTest(long warmup, long duration, int threads, long maxLatency, int rangesCnt, int payLoadSize, boolean procFromNioThread)` Runs IO latency test against all remote server nodes in cluster.
    `void` | IgniteMXBean.`runIoTest(long warmup, long duration, int threads, long maxLatency, int rangesCnt, int payLoadSize, boolean procFromNioThread)` Runs IO latency test against all remote server nodes in cluster.
    `void` | IgniteMXBean.`runIoTest(long warmup, long duration, int threads, long maxLatency, int rangesCnt, int payLoadSize, boolean procFromNioThread)` Runs IO latency test against all remote server nodes in cluster.
    `void` | IgniteMXBean.`runIoTest(long warmup, long duration, int threads, long maxLatency, int rangesCnt, int payLoadSize, boolean procFromNioThread)` Runs IO latency test against all remote server nodes in cluster.
    `boolean` | DefragmentationMXBean.`schedule(String cacheNames)` Schedule defragmentation for given caches.
    `void` | BaselineAutoAdjustMXBean.`setAutoAdjustmentEnabled(boolean enabled)`
    `void` | BaselineAutoAdjustMXBean.`setAutoAdjustmentTimeout(long timeout)`
    `void` | TransactionsMXBean.`setLongOperationsDumpTimeout(long timeout)` Setting a timeout (in millis) for printing long-running transactions as well as transactions that cannot receive locks for all their keys for a long time.
    `void` | TransactionsMXBean.`setLongTransactionTimeDumpThreshold(long threshold)` Sets threshold timeout in milliseconds for long transactions, if transaction exceeds it, it will be dumped in log with information about how much time did it spent in system time (time while aquiring locks, preparing, commiting, etc.)
    `void` | TransactionsMXBean.`setTransactionTimeDumpSamplesCoefficient(double coefficient)` Sets the coefficient for samples of completed transactions that will be dumped in log.
    `void` | TransactionsMXBean.`setTransactionTimeDumpSamplesPerSecondLimit(int limit)` Sets the limit of samples of completed transactions that will be dumped in log per second, if `TransactionsMXBean.getTransactionTimeDumpSamplesCoefficient()` is above `0.0`.
    `void` | TransactionsMXBean.`setTxOwnerDumpRequestsAllowed(boolean allowed)` Sets if dump requests from local node to near node are allowed, when long running transaction is found.
    `void` | TransactionsMXBean.`setTxTimeoutOnPartitionMapExchange(long timeout)` Sets transaction timeout on partition map exchange.
    `void` | DataStorageMXBean.`setWalCompactionLevel(int walCompactionLevel)` Sets ZIP compression level to WAL compaction.
    `boolean` | IgnitionMXBean.`stop(boolean cancel)` Stops default grid instance.
    `boolean` | IgnitionMXBean.`stop(String name, boolean cancel)` Stops named Ignite instance.
    `boolean` | IgnitionMXBean.`stop(String name, boolean cancel)` Stops named Ignite instance.
    `void` | IgnitionMXBean.`stopAll(boolean cancel)` Stops all started grids.
    `boolean` | WorkersControlMXBean.`stopThreadById(long id)` Stops thread by `id`, if exists.
    `boolean` | WorkersControlMXBean.`stopThreadByUniqueName(String name)` Stops thread by `name`, if exists and unique.
    `void` | PersistenceMetricsMXBean.`subIntervals(int subInts)` Deprecated. Sets a number of sub-intervals the whole `PersistenceMetricsMXBean.rateTimeInterval(long)` will be split into to calculate rate-based metrics.
    `void` | MemoryMetricsMXBean.`subIntervals(int subInts)` Deprecated. Sets a number of sub-intervals the whole `MemoryMetricsMXBean.rateTimeInterval(long)` will be split into to calculate `MemoryMetricsMXBean.getAllocationRate()` and `MemoryMetricsMXBean.getEvictionRate()` rates (5 by default).
    `void` | DataRegionMetricsMXBean.`subIntervals(int subInts)` Deprecated. Use `MetricsMxBean.configureHitRateMetric(String, long)` instead.
    `void` | DataStorageMetricsMXBean.`subIntervals(int subInts)` Deprecated. Use `MetricsMxBean.configureHitRateMetric(String, long)` instead.
    `boolean` | WorkersControlMXBean.`terminateWorker(String name)` Terminates worker.
    `void` | IgniteMXBean.`undeployTaskFromGrid(String taskName)` Makes the best attempt to undeploy a task from the whole grid.

  - ### Uses of MXBeanParameter in org.apache.ignite.spi.discovery.tcp

    Method parameters in org.apache.ignite.spi.discovery.tcp with annotations of type MXBeanParameter
    Modifier and Type | Method and Description
    --- | ---
    `void` | TcpDiscoverySpiMBean.`checkRingLatency(int maxHops)` Diagnosis method for determining ring message latency.

2022 Copyright © Apache Software Foundation
| Follow @ApacheIgnite
Ignite Database and Caching Platform | : ver. 2.12.0
Release Date | : January 10 2022