Record Class AnthropicApi.PingEvent

java.lang.Object
java.lang.Record
org.springframework.ai.anthropic.api.AnthropicApi.PingEvent
Record Components:
type - The event type.
All Implemented Interfaces:
AnthropicApi.StreamEvent
Enclosing class:
AnthropicApi
public static record AnthropicApi.PingEvent(AnthropicApi.EventType type) extends Record implements AnthropicApi.StreamEvent
Ping event.
Since:
1.0.0
Author:
Christian Tzolov, Mariusz Bernacki, Thomas Vitale, Jihoon Kim, Alexandros Pappas, Jonghoon Park, Claudio Silva Junior, Filip Hrisafov, Soby Chacko, Austin Dase

  • Constructor Details

    • PingEvent

      public PingEvent(AnthropicApi.EventType type)
      Creates an instance of a PingEvent record class.
      Parameters:
      type - the value for the type record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • type

      public AnthropicApi.EventType type()
      Returns the value of the type record component.
      Specified by:
      type in interface AnthropicApi.StreamEvent
      Returns:
      the value of the type record component