## Uses of Interface
org.apache.ignite.Ignite

- Packages that use Ignite
  Package | Description
  --- | ---
  org.apache.ignite | Contains entry-point Ignite & HPC APIs.
  org.apache.ignite.cache | Contains main Data Grid APIs.
  org.apache.ignite.cache.store.jdbc | Contains reference JDBC-based cache store implementation.
  org.apache.ignite.cluster | Contains cluster-related classes.
  org.apache.ignite.failure | Contains Failure handling public API with standard FailureHandler implementations.
  org.apache.ignite.messaging | Contains Topic-based Messaging functionality.
  org.apache.ignite.ml.dataset | Base package for machine learning dataset classes.
  org.apache.ignite.ml.dataset.impl.cache | Base package for cache based implementation of machine learning dataset.
  org.apache.ignite.ml.dataset.impl.cache.util | Contains util classes used in cache based implementation of dataset.
  org.apache.ignite.ml.inference | Root package for model inference functionality.
  org.apache.ignite.ml.inference.builder | Root package for model inference builders.
  org.apache.ignite.ml.inference.storage.descriptor | Root package for inference model descriptor storages.
  org.apache.ignite.ml.inference.storage.model | Root package for inference model storages.
  org.apache.ignite.ml.pipeline | Contains Pipeline API.
  org.apache.ignite.ml.preprocessing | Base package for machine learning preprocessing classes.
  org.apache.ignite.ml.selection.cv | Root package for cross-validation algorithms.
  org.apache.ignite.ml.sql | Contains util classes that help to work with machine learning models in SQL and train models on data from SQL tables.
  org.apache.ignite.ml.trainers | Contains model trainers.
  org.apache.ignite.plugin | Contains plugins management API.
  org.apache.ignite.spi | Contains common classes and interfaces for SPI implementations.
  org.apache.ignite.spi.communication.tcp | Contains default TCP/IP-based implementation for communication SPI.
  org.apache.ignite.spi.discovery.isolated | Contains implementation of special "isolated" mode for single-node cluster.
  org.apache.ignite.spi.discovery.tcp | Contains default TCP/IP implementation for discovery SPI.
  org.apache.ignite.spi.discovery.tcp.ipfinder | Contains IP finder interface and adapter.
  org.apache.ignite.stream | Contains Ignite Streamer classes.

- - ### Uses of Ignite in org.apache.ignite

    Classes in org.apache.ignite that implement Ignite
    Modifier and Type | Class and Description
    --- | ---
    `class` | `IgniteSpringBean` Ignite Spring bean allows to bypass `Ignition` methods.

    Methods in org.apache.ignite that return Ignite
    Modifier and Type | Method and Description
    --- | ---
    `static Ignite` | Ignition.`getOrStart(IgniteConfiguration cfg)` Gets or starts new grid instance if it hasn't been started yet.
    `static Ignite` | Ignition.`ignite()` Gets an instance of default no-name grid.
    `static Ignite` | Ignition.`ignite(@Nullable String name)` Gets a named Ignite instance.
    `static Ignite` | Ignition.`ignite(UUID locNodeId)` Gets a grid instance for given local node ID.
    `static Ignite` | Ignition.`localIgnite()` This method is used to address a local `Ignite` instance, principally from closure.
    `static Ignite` | Ignition.`start()` Starts grid with default configuration.
    `static Ignite` | IgniteSpring.`start(@Nullable org.springframework.context.ApplicationContext springCtx)` Starts grid with default configuration.
    `static Ignite` | Ignition.`start(IgniteConfiguration cfg)` Starts grid with given configuration.
    `static Ignite` | IgniteSpring.`start(IgniteConfiguration cfg, @Nullable org.springframework.context.ApplicationContext springCtx)` Starts grid with given configuration.
    `static Ignite` | Ignition.`start(InputStream springCfgStream)` Starts all grids specified within given Spring XML configuration input stream.
    `static Ignite` | Ignition.`start(String springCfgPath)` Starts all grids specified within given Spring XML configuration file.
    `static Ignite` | IgniteSpring.`start(String springCfgPath, @Nullable org.springframework.context.ApplicationContext springCtx)` Starts all grids specified within given Spring XML configuration file.
    `static Ignite` | Ignition.`start(URL springCfgUrl)` Starts all grids specified within given Spring XML configuration file URL.
    `static Ignite` | IgniteSpring.`start(URL springCfgUrl, @Nullable org.springframework.context.ApplicationContext springCtx)` Starts all grids specified within given Spring XML configuration file URL.

    Methods in org.apache.ignite that return types with arguments of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `static List<Ignite>` | Ignition.`allGrids()` Gets a list of all grids started so far.

  - ### Uses of Ignite in org.apache.ignite.cache

    Methods in org.apache.ignite.cache with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `javax.cache.CacheManager` | CachingProvider.`findManager(Ignite ignite)`

  - ### Uses of Ignite in org.apache.ignite.cache.store.jdbc

    Fields in org.apache.ignite.cache.store.jdbc declared as Ignite
    Modifier and Type | Field and Description
    --- | ---
    `protected Ignite` | CacheAbstractJdbcStore.`ignite` Auto injected ignite instance.

    Methods in org.apache.ignite.cache.store.jdbc that return Ignite
    Modifier and Type | Method and Description
    --- | ---
    `protected Ignite` | CacheAbstractJdbcStore.`ignite()`

  - ### Uses of Ignite in org.apache.ignite.cluster

    Methods in org.apache.ignite.cluster that return Ignite
    Modifier and Type | Method and Description
    --- | ---
    `Ignite` | ClusterGroup.`ignite()` Gets instance of grid.

  - ### Uses of Ignite in org.apache.ignite.failure

    Methods in org.apache.ignite.failure with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `protected boolean` | NoOpFailureHandler.`handle(Ignite ignite, FailureContext failureCtx)` Actual failure handling.
    `protected boolean` | RestartProcessFailureHandler.`handle(Ignite ignite, FailureContext failureCtx)` Actual failure handling.
    `protected abstract boolean` | AbstractFailureHandler.`handle(Ignite ignite, FailureContext failureCtx)` Actual failure handling.
    `boolean` | StopNodeFailureHandler.`handle(Ignite ignite, FailureContext failureCtx)` Actual failure handling.
    `protected boolean` | StopNodeOrHaltFailureHandler.`handle(Ignite ignite, FailureContext failureCtx)` Actual failure handling.
    `boolean` | AbstractFailureHandler.`onFailure(Ignite ignite, FailureContext failureCtx)` Handles failure occurred on `ignite` instance.
    `boolean` | FailureHandler.`onFailure(Ignite ignite, FailureContext failureCtx)` Handles failure occurred on `ignite` instance.

  - ### Uses of Ignite in org.apache.ignite.messaging

    Methods in org.apache.ignite.messaging that return Ignite
    Modifier and Type | Method and Description
    --- | ---
    `protected Ignite` | MessagingListenActor.`ignite()` Gets grid instance associated with this actor.

  - ### Uses of Ignite in org.apache.ignite.ml.dataset

    Methods in org.apache.ignite.ml.dataset with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `static <K,V,C extends Serializable,D extends AutoCloseable> Dataset<C,D>` | DatasetFactory.`create(Ignite ignite, IgniteCache<K,V> upstreamCache, LearningEnvironmentBuilder envBuilder, PartitionContextBuilder<K,V,C> partCtxBuilder, PartitionDataBuilder<K,V,C,D> partDataBuilder, LearningEnvironment environment)` Creates a new instance of distributed dataset using the specified `partCtxBuilder` and `partDataBuilder`.
    `static <K,V,C extends Serializable,D extends AutoCloseable> Dataset<C,D>` | DatasetFactory.`create(Ignite ignite, IgniteCache<K,V> upstreamCache, PartitionContextBuilder<K,V,C> partCtxBuilder, PartitionDataBuilder<K,V,C,D> partDataBuilder)` Creates a new instance of distributed dataset using the specified `partCtxBuilder` and `partDataBuilder`.
    `static <K,V,C extends Serializable,CO extends Serializable> SimpleDataset<C>` | DatasetFactory.`createSimpleDataset(Ignite ignite, IgniteCache<K,V> upstreamCache, LearningEnvironmentBuilder envBuilder, PartitionContextBuilder<K,V,C> partCtxBuilder, Preprocessor<K,V> featureExtractor)` Creates a new instance of distributed `SimpleDataset` using the specified `partCtxBuilder` and `featureExtractor`.
    `static <K,V,CO extends Serializable> SimpleDataset<EmptyContext>` | DatasetFactory.`createSimpleDataset(Ignite ignite, IgniteCache<K,V> upstreamCache, LearningEnvironmentBuilder envBuilder, Preprocessor<K,V> featureExtractor)` Creates a new instance of distributed `SimpleDataset` using the specified `featureExtractor`.
    `static <K,V,CO extends Serializable> SimpleDataset<EmptyContext>` | DatasetFactory.`createSimpleDataset(Ignite ignite, IgniteCache<K,V> upstreamCache, Preprocessor<K,V> featureExtractor)` Creates a new instance of distributed `SimpleDataset` using the specified `featureExtractor`.
    `static <K,V,C extends Serializable,CO extends Serializable> SimpleLabeledDataset<C>` | DatasetFactory.`createSimpleLabeledDataset(Ignite ignite, IgniteCache<K,V> upstreamCache, LearningEnvironmentBuilder envBuilder, PartitionContextBuilder<K,V,C> partCtxBuilder, Preprocessor<K,V> vectorizer)` Creates a new instance of distributed `SimpleLabeledDataset` using the specified `partCtxBuilder`, `featureExtractor` and `lbExtractor`.
    `static <K,V,CO extends Serializable> SimpleLabeledDataset<EmptyContext>` | DatasetFactory.`createSimpleLabeledDataset(Ignite ignite, LearningEnvironmentBuilder envBuilder, IgniteCache<K,V> upstreamCache, Preprocessor<K,V> vectorizer)` Creates a new instance of distributed `SimpleLabeledDataset` using the specified `featureExtractor` and `lbExtractor`.

  - ### Uses of Ignite in org.apache.ignite.ml.dataset.impl.cache

    Constructors in org.apache.ignite.ml.dataset.impl.cache with parameters of type Ignite
    Constructor and Description
    `CacheBasedDataset(Ignite ignite, IgniteCache<K,V> upstreamCache, IgniteBiPredicate<K,V> filter, UpstreamTransformerBuilder upstreamTransformerBuilder, IgniteCache<Integer,C> datasetCache, LearningEnvironmentBuilder envBuilder, PartitionDataBuilder<K,V,C,D> partDataBuilder, UUID datasetId, boolean upstreamKeepBinary, LearningEnvironment localLearningEnv, int retriesCnt)` Constructs a new instance of dataset based on Ignite Cache, which is used as `upstream` and as reliable storage for partition `context` as well.
    `CacheBasedDatasetBuilder(Ignite ignite, IgniteCache<K,V> upstreamCache)` Constructs a new instance of cache based dataset builder that makes `CacheBasedDataset` with default predicate that passes all upstream entries to dataset.
    `CacheBasedDatasetBuilder(Ignite ignite, IgniteCache<K,V> upstreamCache, IgniteBiPredicate<K,V> filter)` Constructs a new instance of cache based dataset builder that makes `CacheBasedDataset`.
    `CacheBasedDatasetBuilder(Ignite ignite, IgniteCache<K,V> upstreamCache, IgniteBiPredicate<K,V> filter, UpstreamTransformerBuilder transformerBuilder)` Constructs a new instance of cache based dataset builder that makes `CacheBasedDataset`.
    `CacheBasedDatasetBuilder(Ignite ignite, IgniteCache<K,V> upstreamCache, IgniteBiPredicate<K,V> filter, UpstreamTransformerBuilder transformerBuilder, Boolean isKeepBinary, int retries)` Constructs a new instance of cache based dataset builder that makes `CacheBasedDataset`.

  - ### Uses of Ignite in org.apache.ignite.ml.dataset.impl.cache.util

    Methods in org.apache.ignite.ml.dataset.impl.cache.util with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `static <R> Collection<R>` | ComputeUtils.`affinityCallWithRetries(Ignite ignite, Collection<String> cacheNames, IgniteFunction<Integer,R> fun, int retries, DeployingContext deployingContext)` Calls the specified `fun` function on all partitions so that is't guaranteed that partitions with the same index of all specified caches will be placed on the same node and will not be moved before computation is finished.
    `static <R> Collection<R>` | ComputeUtils.`affinityCallWithRetries(Ignite ignite, Collection<String> cacheNames, IgniteFunction<Integer,R> fun, int retries, int interval, DeployingContext deployingCtx)` Calls the specified `fun` function on all partitions so that is't guaranteed that partitions with the same index of all specified caches will be placed on the same node and will not be moved before computation is finished.
    `static <C extends Serializable> C` | ComputeUtils.`getContext(Ignite ignite, String datasetCacheName, int part)` Extracts partition `context` from the Ignite Cache.
    `static <K,V,C extends Serializable,D extends AutoCloseable> D` | ComputeUtils.`getData(Ignite ignite, String upstreamCacheName, IgniteBiPredicate<K,V> filter, UpstreamTransformerBuilder transformerBuilder, String datasetCacheName, UUID datasetId, PartitionDataBuilder<K,V,C,D> partDataBuilder, LearningEnvironment env, boolean isKeepBinary)` Extracts partition `data` from the local storage, if it's not found in local storage recovers this `data` from a partition `upstream` and `context`.
    `static LearningEnvironment` | ComputeUtils.`getLearningEnvironment(Ignite ignite, UUID datasetId, int part, LearningEnvironmentBuilder envBuilder)` Gets learning environment for given partition.
    `static <K,V,C extends Serializable> void` | ComputeUtils.`initContext(Ignite ignite, String upstreamCacheName, UpstreamTransformerBuilder transformerBuilder, IgniteBiPredicate<K,V> filter, String datasetCacheName, PartitionContextBuilder<K,V,C> ctxBuilder, LearningEnvironmentBuilder envBuilder, int retries, int interval, boolean isKeepBinary, DeployingContext deployingCtx)` Initializes partition `context` by loading it from a partition `upstream`.
    `static void` | ComputeUtils.`removeData(Ignite ignite, UUID datasetId)` Remove data from local cache by Dataset ID.
    `static void` | ComputeUtils.`removeLearningEnv(Ignite ignite, UUID datasetId)` Remove learning environment from local cache by Dataset ID.
    `static <C extends Serializable> void` | ComputeUtils.`saveContext(Ignite ignite, String datasetCacheName, int part, C ctx)` Saves the specified partition `context` into the Ignite Cache.

  - ### Uses of Ignite in org.apache.ignite.ml.inference

    Methods in org.apache.ignite.ml.inference with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `static Model<Vector,Future<Double>>` | IgniteModelStorageUtil.`getAsyncModel(Ignite ignite, String name, AsyncModelBuilder mdlBldr)` Retrieves Ignite model by name using asynchronous model builder.
    `static <I extends Serializable,O extends Serializable> Model<I,O>` | IgniteModelStorageUtil.`getModel(Ignite ignite, String name)` Retrieves Ignite model by name using `SingleModelBuilder`.
    `static <I extends Serializable,O extends Serializable> Model<I,O>` | IgniteModelStorageUtil.`getSyncModel(Ignite ignite, String name, SyncModelBuilder mdlBldr)` Retrieves Ignite model by name using synchronous model builder.
    `static void` | IgniteModelStorageUtil.`removeModel(Ignite ignite, String name)` Removes model with specified name.
    `static <I extends Serializable,O extends Serializable> void` | IgniteModelStorageUtil.`saveModel(Ignite ignite, IgniteModel<I,O> mdl, String name)` Saved specified model with specified name.

  - ### Uses of Ignite in org.apache.ignite.ml.inference.builder

    Constructors in org.apache.ignite.ml.inference.builder with parameters of type Ignite
    Constructor and Description
    `IgniteDistributedModelBuilder(Ignite ignite, int instances, int maxPerNode)` Constructs a new instance of Ignite distributed inference model builder.

  - ### Uses of Ignite in org.apache.ignite.ml.inference.storage.descriptor

    Methods in org.apache.ignite.ml.inference.storage.descriptor with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `ModelDescriptorStorage` | ModelDescriptorStorageFactory.`getModelDescriptorStorage(Ignite ignite)` Returns model descriptor storage based on Apache Ignite cache.

  - ### Uses of Ignite in org.apache.ignite.ml.inference.storage.model

    Methods in org.apache.ignite.ml.inference.storage.model with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `ModelStorage` | ModelStorageFactory.`getModelStorage(Ignite ignite)` Returns model storage based on Apache Ignite cache.

  - ### Uses of Ignite in org.apache.ignite.ml.pipeline

    Methods in org.apache.ignite.ml.pipeline with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `PipelineMdl<K,V>` | Pipeline.`fit(Ignite ignite, IgniteCache<K,V> cache)` Fits the pipeline to the input cache.

  - ### Uses of Ignite in org.apache.ignite.ml.preprocessing

    Methods in org.apache.ignite.ml.preprocessing with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `default Preprocessor<K,V>` | PreprocessingTrainer.`fit(Ignite ignite, IgniteCache<K,V> cache, Preprocessor<K,V> basePreprocessor)` Fits preprocessor.
    `default Preprocessor<K,V>` | PreprocessingTrainer.`fit(LearningEnvironmentBuilder envBuilder, Ignite ignite, IgniteCache<K,V> cache, Preprocessor<K,V> basePreprocessor)` Fits preprocessor.

  - ### Uses of Ignite in org.apache.ignite.ml.selection.cv

    Methods in org.apache.ignite.ml.selection.cv with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `CrossValidation<M,K,V>` | CrossValidation.`withIgnite(Ignite ignite)`

  - ### Uses of Ignite in org.apache.ignite.ml.sql

    Constructors in org.apache.ignite.ml.sql with parameters of type Ignite
    Constructor and Description
    `SqlDatasetBuilder(Ignite ignite, String upstreamCache)` Constructs a new instance of cache based dataset builder that makes `CacheBasedDataset` with default predicate that passes all upstream entries to dataset.
    `SqlDatasetBuilder(Ignite ignite, String upstreamCache, IgniteBiPredicate<Object,BinaryObject> filter)` Constructs a new instance of cache based dataset builder that makes `CacheBasedDataset`.
    `SqlDatasetBuilder(Ignite ignite, String upstreamCache, IgniteBiPredicate<Object,BinaryObject> filter, UpstreamTransformerBuilder transformerBuilder)` Constructs a new instance of cache based dataset builder that makes `CacheBasedDataset`.

  - ### Uses of Ignite in org.apache.ignite.ml.trainers

    Methods in org.apache.ignite.ml.trainers with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `<K,V> M` | DatasetTrainer.`fit(Ignite ignite, IgniteCache<K,V> cache, IgniteBiPredicate<K,V> filter, Preprocessor<K,V> preprocessor)` Trains model based on the specified data.
    `<K,V> M` | DatasetTrainer.`fit(Ignite ignite, IgniteCache<K,V> cache, Preprocessor<K,V> preprocessor)` Trains model based on the specified data.
    `<K,V> M` | DatasetTrainer.`update(M mdl, Ignite ignite, IgniteCache<K,V> cache, IgniteBiPredicate<K,V> filter, Preprocessor<K,V> preprocessor)` Gets state of model in arguments, update in according to new data and return new model.
    `<K,V> M` | DatasetTrainer.`update(M mdl, Ignite ignite, IgniteCache<K,V> cache, Preprocessor<K,V> preprocessor)` Gets state of model in arguments, update in according to new data and return new model.

  - ### Uses of Ignite in org.apache.ignite.plugin

    Methods in org.apache.ignite.plugin that return Ignite
    Modifier and Type | Method and Description
    --- | ---
    `Ignite` | PluginContext.`grid()`
    `Ignite` | CachePluginContext.`grid()`

  - ### Uses of Ignite in org.apache.ignite.spi

    Fields in org.apache.ignite.spi declared as Ignite
    Modifier and Type | Field and Description
    --- | ---
    `protected Ignite` | IgniteSpiAdapter.`ignite` Ignite instance.

    Methods in org.apache.ignite.spi that return Ignite
    Modifier and Type | Method and Description
    --- | ---
    `Ignite` | IgniteSpiAdapter.`ignite()` Gets ignite instance.

    Methods in org.apache.ignite.spi with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | IgniteSpiAdapter.`injectResources(Ignite ignite)` Inject ignite instance.

  - ### Uses of Ignite in org.apache.ignite.spi.communication.tcp

    Constructors in org.apache.ignite.spi.communication.tcp with parameters of type Ignite
    Constructor and Description
    `TcpCommunicationMetricsListener(Ignite ignite, IgniteSpiContext spiCtx)`

  - ### Uses of Ignite in org.apache.ignite.spi.discovery.isolated

    Methods in org.apache.ignite.spi.discovery.isolated with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | IsolatedDiscoverySpi.`injectResources(Ignite ignite)` Inject ignite instance.

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

    Methods in org.apache.ignite.spi.discovery.tcp with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | TcpDiscoverySpi.`injectResources(Ignite ignite)` Inject resources

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

    Fields in org.apache.ignite.spi.discovery.tcp.ipfinder declared as Ignite
    Modifier and Type | Field and Description
    --- | ---
    `protected Ignite` | TcpDiscoveryIpFinderAdapter.`ignite` Deprecated. Since 2.8. May contain an invalid Ignite instance when multiple nodes shares same `TcpDiscoveryIpFinder` instance.

  - ### Uses of Ignite in org.apache.ignite.stream

    Fields in org.apache.ignite.stream declared as Ignite
    Modifier and Type | Field and Description
    --- | ---
    `protected Ignite` | StreamAdapter.`ignite` Ignite.

    Methods in org.apache.ignite.stream that return Ignite
    Modifier and Type | Method and Description
    --- | ---
    `Ignite` | StreamAdapter.`getIgnite()`

    Methods in org.apache.ignite.stream with parameters of type Ignite
    Modifier and Type | Method and Description
    --- | ---
    `void` | StreamAdapter.`setIgnite(Ignite ignite)`

${current.year} Copyright © Apache Software Foundation
| Follow @ApacheIgnite
Ignite Database and Caching Platform | : ver. 2.15.0
Release Date | : April 25 2023