Package org.springframework.boot.logging.structured

Record Class ElasticCommonSchemaService

java.lang.Object
java.lang.Record
org.springframework.boot.logging.structured.ElasticCommonSchemaService
Record Components:
name - the application name
version - the version of the application
environment - the name of the environment the application is running in
nodeName - the name of the node the application is running on
public record ElasticCommonSchemaService(String name, String version, String environment, String nodeName) extends Record
Service details for Elastic Common Schema structured logging.
Since:
3.4.0
Author:
Moritz Halbritter, Phillip Webb

  • Constructor Details

    • ElasticCommonSchemaService

      public ElasticCommonSchemaService(String name, String version, String environment, String nodeName)
      Creates an instance of a ElasticCommonSchemaService record class.
      Parameters:
      name - the value for the name record component
      version - the value for the version record component
      environment - the value for the environment record component
      nodeName - the value for the nodeName record component

  • Method Details

    • jsonMembers

      public void jsonMembers(JsonWriter.Members<?> members)
      Add JsonWriter members for the service.
      Parameters:
      members - the members to add to

    • get

      public static ElasticCommonSchemaService get(Environment environment)
      Return a new ElasticCommonSchemaService from bound from properties in the given Environment.
      Parameters:
      environment - the source environment
      Returns:
      a new ElasticCommonSchemaService instance

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

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • version

      public String version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component

    • environment

      public String environment()
      Returns the value of the environment record component.
      Returns:
      the value of the environment record component

    • nodeName

      public String nodeName()
      Returns the value of the nodeName record component.
      Returns:
      the value of the nodeName record component