ClusterHealthChunkQueryDescription Class

The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.

Inheritance

Model

ClusterHealthChunkQueryDescription

Constructor

ClusterHealthChunkQueryDescription(*, node_filters=None, application_filters=None, cluster_health_policy=None, application_health_policies=None, **kwargs)

Parameters

node_filters

list[NodeHealthStateFilter]

Required

Defines a list of filters that specify which nodes to be included in the returned cluster health chunk. If no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple node filters. For example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName.

application_filters

list[ApplicationHealthStateFilter]

Required

Defines a list of filters that specify which applications to be included in the returned cluster health chunk. If no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple application filters. For example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type.

cluster_health_policy

ClusterHealthPolicy

Required

Defines a health policy used to evaluate the health of the cluster or of a cluster node.

application_health_policies

ApplicationHealthPolicies

Required

Defines the application health policy map used to evaluate the health of an application or one of its children entities.