BroadcastKey (Hazelcast Root 5.4.0-SNAPSHOT API)

java.lang.Object
- com.hazelcast.jet.core.BroadcastKey<K>

Type Parameters:

K - type of key
```
public final class BroadcastKey<K>
extends java.lang.Object
```
Marks a key in the snapshot state to indicate that the corresponding entry should be broadcast to all processors when restoring the snapshot.

Since:

Jet 3.0

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static <K> BroadcastKey<K>`	`broadcastKey(K key)`	Returns a given key as a broadcast key.
`boolean`	`equals(java.lang.Object o)`
`int`	`hashCode()`
`K`	`key()`	Returns the underlying key
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - key
```
@Nonnull
public K key()
```
    Returns the underlying key
  - broadcastKey
```
@Nonnull
public static <K> BroadcastKey<K> broadcastKey(@Nonnull
                                               K key)
```
    Returns a given key as a broadcast key.
    Note: Several processor instances can use the returned BroadcastKey with the same key to store unique values and the values will not overwrite each other. Upon a snapshot restore, each processor will receive multiple key-value pairs with the given BroadcastKey
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object