Uuid (clients 7.7.1-ce API)

java.lang.Object
- org.apache.kafka.common.Uuid

All Implemented Interfaces:

Comparable<Uuid>
```
public class Uuid
extends Object
implements Comparable<Uuid>
```
This class defines an immutable universally unique identifier (UUID). It represents a 128-bit value. More specifically, the random UUIDs generated by this class are variant 2 (Leach-Salz) version 4 UUIDs. This is the same type of UUID as the ones generated by java.util.UUID. The toString() method prints using the base64 string encoding. Likewise, the fromString method expects a base64 string encoding.

Field Summary

Fields
Modifier and Type	Field and Description
`static Uuid`	`METADATA_TOPIC_ID` A UUID for the metadata topic in KRaft mode.
`static Uuid`	`ONE_UUID` A reserved UUID.
`static Set<Uuid>`	`RESERVED` The set of reserved UUIDs that will never be returned by the randomUuid method.
`static Uuid`	`ZERO_UUID` A UUID that represents a null or empty UUID.

Constructor Summary

Constructors
Constructor and Description
`Uuid(long mostSigBits, long leastSigBits)` Constructs a 128-bit type 4 UUID where the first long represents the most significant 64 bits and the second long represents the least significant 64 bits.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Uuid other)`
`boolean`	`equals(Object obj)` Returns true iff obj is another Uuid represented by the same two long values.
`static Uuid`	`fromString(String str)` Creates a UUID based on a base64 string encoding used in the toString() method.
`long`	`getLeastSignificantBits()` Returns the least significant bits of the UUID's 128 value.
`long`	`getMostSignificantBits()` Returns the most significant bits of the UUID's 128 value.
`int`	`hashCode()` Returns a hash code for this UUID
`static Uuid`	`randomUuid()` Static factory to retrieve a type 4 (pseudo randomly generated) UUID.
`static Uuid[]`	`toArray(List<Uuid> list)` Convert a list of Uuid to an array of Uuid.
`static List<Uuid>`	`toList(Uuid[] array)` Convert an array of Uuids to a list of Uuid.
`String`	`toString()` Returns a base64 string encoding of the UUID.

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

- Field Detail
  - ONE_UUID
```
public static final Uuid ONE_UUID
```
    A reserved UUID. Will never be returned by the randomUuid method.
  - METADATA_TOPIC_ID
```
public static final Uuid METADATA_TOPIC_ID
```
    A UUID for the metadata topic in KRaft mode. Will never be returned by the randomUuid method.
  - ZERO_UUID
```
public static final Uuid ZERO_UUID
```
    A UUID that represents a null or empty UUID. Will never be returned by the randomUuid method.
  - RESERVED
```
public static final Set<Uuid> RESERVED
```
    The set of reserved UUIDs that will never be returned by the randomUuid method.
- Constructor Detail
  - Uuid
```
public Uuid(long mostSigBits,
            long leastSigBits)
```
    Constructs a 128-bit type 4 UUID where the first long represents the most significant 64 bits and the second long represents the least significant 64 bits.
- Method Detail
  - randomUuid
```
public static Uuid randomUuid()
```
    Static factory to retrieve a type 4 (pseudo randomly generated) UUID. This will not generate a UUID equal to 0, 1, or one whose string representation starts with a dash ("-")
  - getMostSignificantBits
```
public long getMostSignificantBits()
```
    Returns the most significant bits of the UUID's 128 value.
  - getLeastSignificantBits
```
public long getLeastSignificantBits()
```
    Returns the least significant bits of the UUID's 128 value.
  - equals
```
public boolean equals(Object obj)
```
    Returns true iff obj is another Uuid represented by the same two long values.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this UUID
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Returns a base64 string encoding of the UUID.
    
    Overrides:
    
    toString in class Object
  - fromString
```
public static Uuid fromString(String str)
```
    Creates a UUID based on a base64 string encoding used in the toString() method.
  - compareTo
```
public int compareTo(Uuid other)
```
    Specified by:
    
    compareTo in interface Comparable<Uuid>
  - toArray
```
public static Uuid[] toArray(List<Uuid> list)
```
    Convert a list of Uuid to an array of Uuid.
    
    Parameters:
    
    list - The input list
    
    Returns:
    
    The output array
  - toList
```
public static List<Uuid> toList(Uuid[] array)
```
    Convert an array of Uuids to a list of Uuid.
    
    Parameters:
    
    array - The input array
    
    Returns:
    
    The output list

Class Uuid

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ONE_UUID

METADATA_TOPIC_ID

ZERO_UUID

RESERVED

Constructor Detail

Uuid

Method Detail

randomUuid

getMostSignificantBits

getLeastSignificantBits

equals

hashCode

toString

fromString

compareTo

toArray

toList