Package org.axonframework.update.api

Record Class UpdateCheckRequest

java.lang.Object
java.lang.Record
org.axonframework.update.api.UpdateCheckRequest
Record Components:
machineId - The unique identifier for the machine. This is a UUID that is generated and stored in the user's home directory.
instanceId - The unique identifier for the instance of the application. This is a UUID that is generated for each JVM instance.
osName - The name of the operating system (e.g., "Linux", "Windows").
osVersion - The version of the operating system (e.g., "6.11.0-26-generic").
osArch - The architecture of the operating system (e.g., "amd64", "x86_64").
jvmVersion - The version of the Java Virtual Machine (JVM) (e.g., "17.0.2").
jvmVendor - The vendor of the JVM (e.g., "AdoptOpenJDK", "Oracle").
kotlinVersion - The version of Kotlin used in the application, or "none" if Kotlin is not used.
libraries - A list of library versions used in the application, each represented by a Artifact object containing the group ID, artifact ID, and version of the library.
@Internal public record UpdateCheckRequest(@Nonnull String machineId, @Nonnull String instanceId, @Nonnull String osName, @Nonnull String osVersion, @Nonnull String osArch, @Nonnull String jvmVersion, @Nonnull String jvmVendor, @Nonnull String kotlinVersion, @Nonnull List<Artifact> libraries) extends Record
Represents an UpdateChecker request, including machine and instance identifiers, operating system details, JVM information, Kotlin version, and a list of library versions.
Since:
5.0.0
Author:
Mitchell Herrijgers

  • Constructor Details

    • UpdateCheckRequest

      public UpdateCheckRequest(@Nonnull String machineId, @Nonnull String instanceId, @Nonnull String osName, @Nonnull String osVersion, @Nonnull String osArch, @Nonnull String jvmVersion, @Nonnull String jvmVendor, @Nonnull String kotlinVersion, @Nonnull List<Artifact> libraries)
      Creates an instance of a UpdateCheckRequest record class.
      Parameters:
      machineId - the value for the machineId record component
      instanceId - the value for the instanceId record component
      osName - the value for the osName record component
      osVersion - the value for the osVersion record component
      osArch - the value for the osArch record component
      jvmVersion - the value for the jvmVersion record component
      jvmVendor - the value for the jvmVendor record component
      kotlinVersion - the value for the kotlinVersion record component
      libraries - the value for the libraries record component

  • Method Details

    • toQueryString

      public String toQueryString()
      Converts the usage request into a query string format suitable for HTTP requests. All values are properly URL encoded.
      Returns:
      The query string representation of the usage request.

    • toUserAgent

      public String toUserAgent()
      Converts the usage request into a user agent string format.
      Returns:
      The user agent string representation of the usage request.

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

    • machineId

      @Nonnull public String machineId()
      Returns the value of the machineId record component.
      Returns:
      the value of the machineId record component

    • instanceId

      @Nonnull public String instanceId()
      Returns the value of the instanceId record component.
      Returns:
      the value of the instanceId record component

    • osName

      @Nonnull public String osName()
      Returns the value of the osName record component.
      Returns:
      the value of the osName record component

    • osVersion

      @Nonnull public String osVersion()
      Returns the value of the osVersion record component.
      Returns:
      the value of the osVersion record component

    • osArch

      @Nonnull public String osArch()
      Returns the value of the osArch record component.
      Returns:
      the value of the osArch record component

    • jvmVersion

      @Nonnull public String jvmVersion()
      Returns the value of the jvmVersion record component.
      Returns:
      the value of the jvmVersion record component

    • jvmVendor

      @Nonnull public String jvmVendor()
      Returns the value of the jvmVendor record component.
      Returns:
      the value of the jvmVendor record component

    • kotlinVersion

      @Nonnull public String kotlinVersion()
      Returns the value of the kotlinVersion record component.
      Returns:
      the value of the kotlinVersion record component

    • libraries

      @Nonnull public List<Artifact> libraries()
      Returns the value of the libraries record component.
      Returns:
      the value of the libraries record component