Package com.hazelcast.kubernetes

Class RuntimeContext

java.lang.Object

com.hazelcast.kubernetes.RuntimeContext

@NotThreadSafe
public class RuntimeContext
extends Object

Models the state of a Kubernetes StatefulSet(s). Note that this class is not thread-safe when instantiated using RuntimeContext() or RuntimeContext(RuntimeContext). RuntimeContext(int, int, int, String) models a single StatefulSet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RuntimeContext.StatefulSetInfo

Field Summary

Fields

Modifier and Type	Field	Description
static final long	UNKNOWN	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
RuntimeContext()	Creates a RuntimeContext(int, int, int, java.lang.String) that can track the state of multiple StatefulSets.
RuntimeContext(int specifiedReplicaCount, int readyReplicas, int currentReplicas, String resourceVersion)	Deprecated, for removal: This API element is subject to removal in a future version. Use RuntimeContext() and addStatefulSetInfo(String, StatefulSetInfo, String) instead.
RuntimeContext(RuntimeContext context)	Creates a RuntimeContext(int, int, int, java.lang.String) whose state is derived from another RuntimeContext(int, int, int, java.lang.String).

Method Summary

Modifier and Type	Method	Description
void	addStatefulSetInfo(String name, RuntimeContext.StatefulSetInfo info, String resourceVersion)	Adds or updates StatefulSet information in this context.
int	getCurrentReplicas()	Returns the total number of current replicas.
int	getReadyReplicas()	Returns the total number of ready replicas.
String	getResourceVersion()	Returns the last resource version specified via addStatefulSetInfo(java.lang.String, com.hazelcast.kubernetes.RuntimeContext.StatefulSetInfo, java.lang.String).
int	getSpecifiedReplicaCount()	Returns the total number of specified replicas.
int	getStatefulSetCount()	Returns the number of StatefulSets tracked by this context.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

UNKNOWN

@Deprecated(forRemoval=true,
            since="5.6")
public static final long UNKNOWN

Deprecated, for removal: This API element is subject to removal in a future version.

Unknown value

See Also:

• Constant Field Values

Constructor Details

RuntimeContext

public RuntimeContext()

Creates a RuntimeContext(int, int, int, java.lang.String) that can track the state of multiple StatefulSets. The created RuntimeContext(int, int, int, java.lang.String) is not thread-safe.

Since:

5.6

RuntimeContext

public RuntimeContext(RuntimeContext context)

Creates a RuntimeContext(int, int, int, java.lang.String) whose state is derived from another RuntimeContext(int, int, int, java.lang.String). The created RuntimeContext(int, int, int, java.lang.String) is not thread-safe.

Throws:

UnsupportedOperationException - when copying a RuntimeContext(int, int, int, java.lang.String) created using RuntimeContext(int, int, int, String).

Since:

5.6

RuntimeContext

@Deprecated(forRemoval=true,
            since="5.6")
public RuntimeContext(int specifiedReplicaCount,
 int readyReplicas,
 int currentReplicas,
 @Nullable
 String resourceVersion)

Deprecated, for removal: This API element is subject to removal in a future version.

Use RuntimeContext() and addStatefulSetInfo(String, StatefulSetInfo, String) instead. This constructor is provided for backward compatibility only.

Creates a RuntimeContext(int, int, int, java.lang.String) that can model a single StatefulSet. The created RuntimeContext(int, int, int, java.lang.String) is thread-safe. The view of state returned by this constructor supports the following API:

• getCurrentReplicas()
• getReadyReplicas()
• getSpecifiedReplicaCount()
• getResourceVersion()
• toString()

All other method invocations will throw UnsupportedOperationException.

Method Details

getSpecifiedReplicaCount

public int getSpecifiedReplicaCount()

Returns the total number of specified replicas. If the context is empty, returns -1.

See Also:

• RuntimeContext.StatefulSetInfo.specifiedReplicaCount()

getReadyReplicas

public int getReadyReplicas()

Returns the total number of ready replicas. If the context is empty, returns -1.

See Also:

• RuntimeContext.StatefulSetInfo.readyReplicas()

getCurrentReplicas

public int getCurrentReplicas()

Returns the total number of current replicas. If the context is empty, returns -1.

See Also:

• RuntimeContext.StatefulSetInfo.currentReplicas()

getResourceVersion

public String getResourceVersion()

Returns the last resource version specified via addStatefulSetInfo(java.lang.String, com.hazelcast.kubernetes.RuntimeContext.StatefulSetInfo, java.lang.String).

getStatefulSetCount

public int getStatefulSetCount()

Returns the number of StatefulSets tracked by this context.

Returns:

the number of StatefulSets

Throws:

UnsupportedOperationException - when the RuntimeContext(int, int, int, java.lang.String) was created using RuntimeContext(int, int, int, String).

Since:

5.6

addStatefulSetInfo

public void addStatefulSetInfo(String name,
 @Nonnull
 RuntimeContext.StatefulSetInfo info,
 String resourceVersion)

Adds or updates StatefulSet information in this context.

Parameters:

name - the name of the StatefulSet

info - the StatefulSet information

resourceVersion - the resource version

Throws:

UnsupportedOperationException - when the RuntimeContext(int, int, int, java.lang.String) was created using RuntimeContext(int, int, int, String).

Since:

5.6

toString

public String toString()

Overrides:

toString in class Object