Package app.kntrl.client.openapi.model

Class ShHttpCfg

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class ShHttpCfg
extends java.lang.Object
    Http server config

    • Constructor Summary

      Constructors 
      Constructor Description
      ShHttpCfg()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ShHttpCfg bind​(java.lang.String bind)  
      boolean equals​(java.lang.Object o)  
      static ShHttpCfg fromJson​(java.lang.String jsonString)
      Create an instance of ShHttpCfg given an JSON string
      java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      java.lang.Object getAdditionalProperty​(java.lang.String key)
      Return the additional (undeclared) property with the specified name.
      java.lang.String getBind()
      IP address to bind to.
      java.lang.Integer getPort()
      A port that the server will use to accept http requests
      java.lang.Boolean getProxy()
      If true, X-Forwarded-For header is used to get client's IP address
      int hashCode()  
      ShHttpCfg port​(java.lang.Integer port)  
      ShHttpCfg proxy​(java.lang.Boolean proxy)  
      ShHttpCfg putAdditionalProperty​(java.lang.String key, java.lang.Object value)
      Set the additional (undeclared) property with the specified name and value.
      void setBind​(java.lang.String bind)  
      void setPort​(java.lang.Integer port)  
      void setProxy​(java.lang.Boolean proxy)  
      java.lang.String toJson()
      Convert an instance of ShHttpCfg to an JSON string
      java.lang.String toString()  
      static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
      Validates the JSON Object and throws an exception if issues found

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • SERIALIZED_NAME_PORT

        public static final java.lang.String SERIALIZED_NAME_PORT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_BIND

        public static final java.lang.String SERIALIZED_NAME_BIND
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_PROXY

        public static final java.lang.String SERIALIZED_NAME_PROXY
        See Also:
        Constant Field Values

      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields

      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields

    • Constructor Detail

      • ShHttpCfg

        public ShHttpCfg()

    • Method Detail

      • port

        public ShHttpCfg port​(java.lang.Integer port)

      • getPort

        @Nullable
public java.lang.Integer getPort()
        A port that the server will use to accept http requests
        Returns:
        port

      • setPort

        public void setPort​(java.lang.Integer port)

      • bind

        public ShHttpCfg bind​(java.lang.String bind)

      • getBind

        @Nullable
public java.lang.String getBind()
        IP address to bind to. Usually 0.0.0.0 to accept for any connection or 127.0.0.1 to accept only localhost
        Returns:
        bind

      • setBind

        public void setBind​(java.lang.String bind)

      • proxy

        public ShHttpCfg proxy​(java.lang.Boolean proxy)

      • getProxy

        @Nullable
public java.lang.Boolean getProxy()
        If true, X-Forwarded-For header is used to get client's IP address
        Returns:
        proxy

      • setProxy

        public void setProxy​(java.lang.Boolean proxy)

      • putAdditionalProperty

        public ShHttpCfg putAdditionalProperty​(java.lang.String key,
                                       java.lang.Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.

      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                               throws java.io.IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        java.io.IOException - if the JSON Object is invalid with respect to ShHttpCfg

      • fromJson

        public static ShHttpCfg fromJson​(java.lang.String jsonString)
                          throws java.io.IOException
        Create an instance of ShHttpCfg given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of ShHttpCfg
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to ShHttpCfg

      • toJson

        public java.lang.String toJson()
        Convert an instance of ShHttpCfg to an JSON string
        Returns:
        JSON string