Leave

java.lang.Object
- akka.cluster.typed.Leave

All Implemented Interfaces:

ClusterCommand, java.io.Serializable, scala.Equals, scala.Product
```
public final class Leave
extends java.lang.Object
implements ClusterCommand, scala.Product, java.io.Serializable
```
Send command to issue state transition to LEAVING for the node specified by 'address'. The member will go through the status changes MemberStatus Leaving (not published to subscribers) followed by MemberStatus Exiting and finally MemberStatus Removed.
Note that this command can be issued to any member in the cluster, not necessarily the one that is leaving. The cluster extension, but not the actor system or JVM, of the leaving member will be shutdown after the leader has changed status of the member to Exiting. Thereafter the member will be removed from the cluster. Normally this is handled automatically, but in case of network failures during this process it might still be necessary to set the node’s status to Down in order to complete the removal.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Leave(Address address)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Address`	`address()`
`static Leave`	`apply(Address address)`
`boolean`	`canEqual(java.lang.Object x$1)`
`Leave`	`copy(Address address)`
`Address`	`copy$default$1()`
`static Leave`	`create(Address address)`	Java API
`boolean`	`equals(java.lang.Object x$1)`
`int`	`hashCode()`
`int`	`productArity()`
`java.lang.Object`	`productElement(int x$1)`
`java.lang.String`	`productElementName(int x$1)`
`scala.collection.Iterator<java.lang.Object>`	`productIterator()`
`java.lang.String`	`productPrefix()`
`java.lang.String`	`toString()`
`static scala.Option<Address>`	`unapply(Leave x$0)`

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

Methods inherited from interface scala.Product
productElementNames

Constructor Detail
- Leave
```
public Leave(Address address)
```

Method Detail

create

public static Leave create(Address address)

Java API

apply

public static Leave apply(Address address)

unapply

public static scala.Option<Address> unapply(Leave x$0)

address
```
public Address address()
```

copy

public Leave copy(Address address)

copy$default$1
```
public Address copy$default$1()
```

productPrefix
```
public java.lang.String productPrefix()
```
Specified by:

productPrefix in interface scala.Product

productArity
```
public int productArity()
```
Specified by:

productArity in interface scala.Product

productElement
```
public java.lang.Object productElement(int x$1)
```
Specified by:

productElement in interface scala.Product

productIterator

public scala.collection.Iterator<java.lang.Object> productIterator()

Specified by:: productIterator in interface scala.Product

canEqual
```
public boolean canEqual(java.lang.Object x$1)
```
Specified by:

canEqual in interface scala.Equals

productElementName
```
public java.lang.String productElementName(int x$1)
```
Specified by:

productElementName in interface scala.Product

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

equals
```
public boolean equals(java.lang.Object x$1)
```
Specified by:

equals in interface scala.Equals

Overrides:

equals in class java.lang.Object