Package org.apache.pekko.cluster.typed

Class Leave

java.lang.Object
org.apache.pekko.cluster.typed.Leave
All Implemented Interfaces:
Serializable, ClusterCommand, scala.Equals, scala.Product
public final class Leave extends Object implements ClusterCommand, scala.Product, 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:

  • Constructor Details

    • Leave

      public Leave(Address address)

  • Method Details

    • 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 String productPrefix()
      Specified by:
      productPrefix in interface scala.Product

    • productArity

      public int productArity()
      Specified by:
      productArity in interface scala.Product

    • productElement

      public Object productElement(int x$1)
      Specified by:
      productElement in interface scala.Product

    • productIterator

      public scala.collection.Iterator<Object> productIterator()
      Specified by:
      productIterator in interface scala.Product

    • canEqual

      public boolean canEqual(Object x$1)
      Specified by:
      canEqual in interface scala.Equals

    • productElementName

      public String productElementName(int x$1)
      Specified by:
      productElementName in interface scala.Product

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object x$1)
      Specified by:
      equals in interface scala.Equals
      Overrides:
      equals in class Object