Record Class AhpSessionCreateRequest

java.lang.Object
java.lang.Record
com.github.copilot.AhpSessionCreateRequest
Record Components:
config - host-selected session settings
cancellation - completes normally when the participation ends; a late factory result is still delivered to the release callback
@CopilotExperimental public record AhpSessionCreateRequest(SessionConfig config, CompletionStage<Void> cancellation) extends Record
An application-owned AHP session creation request. Preserve the supplied settings when adding application tools, prompts, permissions, and hooks.

  • Constructor Details

    • AhpSessionCreateRequest

      public AhpSessionCreateRequest(SessionConfig config, CompletionStage<Void> cancellation)
      Creates an instance of a AhpSessionCreateRequest record class.
      Parameters:
      config - the value for the config record component
      cancellation - the value for the cancellation 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.

    • config

      public SessionConfig config()
      Returns the value of the config record component.
      Returns:
      the value of the config record component

    • cancellation

      public CompletionStage<Void> cancellation()
      Returns the value of the cancellation record component.
      Returns:
      the value of the cancellation record component