blob: d953b5c8ae9ed92320555b75755e20c6b589df9e [file] [log] [blame]
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
This module contains `Cluster` that lets you get info and change state of the
whole cluster.
"""
from pyignite.api.cluster import cluster_get_state, cluster_set_state
from pyignite.exceptions import ClusterError
from pyignite.utils import status_to_exception
from pyignite.datatypes import ClusterState
class Cluster:
"""
Ignite cluster abstraction. Users should never use this class directly,
but construct its instances with
:py:meth:`~pyignite.client.Client.get_cluster` method instead.
"""
def __init__(self, client: 'Client'):
"""
:param client: :py:class:`~pyignite.client.Client` instance.
"""
self._client = client
@status_to_exception(ClusterError)
def get_state(self) -> 'ClusterState':
"""
Gets current cluster state.
:return: Current cluster state. This is one of
:py:attr:`~pyignite.datatypes.cluster_state.ClusterState.INACTIVE`,
:py:attr:`~pyignite.datatypes.cluster_state.ClusterState.ACTIVE`,
:py:attr:`~pyignite.datatypes.cluster_state.ClusterState.ACTIVE_READ_ONLY`.
"""
return cluster_get_state(self._client.random_node)
@status_to_exception(ClusterError)
def set_state(self, state: 'ClusterState'):
"""
Changes current cluster state to the given.
Note: Deactivation clears in-memory caches (without persistence)
including the system caches.
:param state: New cluster state. This is one of
:py:attr:`~pyignite.datatypes.cluster_state.ClusterState.INACTIVE`,
:py:attr:`~pyignite.datatypes.cluster_state.ClusterState.ACTIVE`,
:py:attr:`~pyignite.datatypes.cluster_state.ClusterState.ACTIVE_READ_ONLY`.
"""
return cluster_set_state(self._client.random_node, state)