Module evita.external.api.graphql
Package io.evitadb.externalApi.graphql.io

Record Class ClientContextExtension

java.lang.Object
java.lang.Record
io.evitadb.externalApi.graphql.io.ClientContextExtension
public record ClientContextExtension(@Nullable String clientId, @Nullable String requestId) extends Record
DTO for passing client context information from client for entire GQL request execution.
Author:
Lukáš Hornych, FG Forrest a.s. (c) 2023
See Also:
  • ClientContext

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClientContextExtension(String clientId, String requestId)
    Creates an instance of a ClientContextExtension record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    clientId()
    Returns the value of the clientId record component.
    static ClientContextExtension
    empty()
    Client didn't send any client context information, but we want to still classify the usage somehow.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    requestId()
    Returns the value of the requestId record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ClientContextExtension

      public ClientContextExtension(@Nullable String clientId, @Nullable String requestId)
      Creates an instance of a ClientContextExtension record class.
      Parameters:
      clientId - the value for the clientId record component
      requestId - the value for the requestId record component

  • Method Details

    • empty

      public static ClientContextExtension empty()
      Client didn't send any client context information, but we want to still classify the usage somehow.

    • 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.

    • clientId

      @Nullable public String clientId()
      Returns the value of the clientId record component.
      Returns:
      the value of the clientId record component

    • requestId

      @Nullable public String requestId()
      Returns the value of the requestId record component.
      Returns:
      the value of the requestId record component