Package com.inductiveautomation.eventstream.config.handler

Record Class HttpHandlerConfig

java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.config.handler.HttpHandlerConfig
Record Components:
type - HTTP method used for each request.
cookiesEnabled - whether cookies returned by the server are stored and sent back.
connectTimeoutMs - maximum time to establish a connection, in milliseconds.
requestTimeoutMs - maximum time to wait for a response after a request is sent, in milliseconds. Zero waits indefinitely.
httpVersion - preferred HTTP protocol version.
url - expression producing the request URL.
headers - expressions producing additional request headers.
body - expression producing the request body.
public record HttpHandlerConfig(HttpHandlerConfig.Type type, boolean cookiesEnabled, int connectTimeoutMs, int requestTimeoutMs, HttpHandlerConfig.HttpVersion httpVersion, ExpressionValue url, List<HttpHandlerConfig.Header> headers, ExpressionValue body) extends Record
Configuration for the HTTP handler.

  • Constructor Details

  • Method Details

    • fromJson

      public static HttpHandlerConfig fromJson(@Nullable com.inductiveautomation.ignition.common.gson.JsonObject config)

    • toJson

      public com.inductiveautomation.ignition.common.gson.JsonObject toJson()

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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 HttpHandlerConfig.Type type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • cookiesEnabled

      public boolean cookiesEnabled()
      Returns the value of the cookiesEnabled record component.
      Returns:
      the value of the cookiesEnabled record component

    • connectTimeoutMs

      public int connectTimeoutMs()
      Returns the value of the connectTimeoutMs record component.
      Returns:
      the value of the connectTimeoutMs record component

    • requestTimeoutMs

      public int requestTimeoutMs()
      Returns the value of the requestTimeoutMs record component.
      Returns:
      the value of the requestTimeoutMs record component

    • httpVersion

      public HttpHandlerConfig.HttpVersion httpVersion()
      Returns the value of the httpVersion record component.
      Returns:
      the value of the httpVersion record component

    • url

      public ExpressionValue url()
      Returns the value of the url record component.
      Returns:
      the value of the url record component

    • headers

      public List<HttpHandlerConfig.Header> headers()
      Returns the value of the headers record component.
      Returns:
      the value of the headers record component

    • body

      public ExpressionValue body()
      Returns the value of the body record component.
      Returns:
      the value of the body record component