Class CodeCfg


  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
    public class CodeCfg
    extends java.lang.Object
    If specified - app generates code and requires auth to be confirmed
    • Field Detail

      • SERIALIZED_NAME_LENGTH

        public static final java.lang.String SERIALIZED_NAME_LENGTH
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_TTL

        public static final java.lang.String SERIALIZED_NAME_TTL
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_ALPHABET

        public static final java.lang.String SERIALIZED_NAME_ALPHABET
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_EASY_TO_REMEMBER

        public static final java.lang.String SERIALIZED_NAME_EASY_TO_REMEMBER
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_MAX_ATTEMPTS

        public static final java.lang.String SERIALIZED_NAME_MAX_ATTEMPTS
        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

      • CodeCfg

        public CodeCfg()
    • Method Detail

      • length

        public CodeCfg length​(java.lang.Integer length)
      • getLength

        @Nullable
        public java.lang.Integer getLength()
        Length of code to be generated
        Returns:
        length
      • setLength

        public void setLength​(java.lang.Integer length)
      • ttl

        public CodeCfg ttl​(java.lang.String ttl)
      • getTtl

        @Nullable
        public java.lang.String getTtl()
        Generated code lifetime. e.g. 1m, 60s, 1d, etc.
        Returns:
        ttl
      • setTtl

        public void setTtl​(java.lang.String ttl)
      • alphabet

        public CodeCfg alphabet​(java.lang.String alphabet)
      • getAlphabet

        @Nullable
        public java.lang.String getAlphabet()
        Symbols used to generate a code. By default `a-z + A-Z + 0-9`.
        Returns:
        alphabet
      • setAlphabet

        public void setAlphabet​(java.lang.String alphabet)
      • easyToRemember

        public CodeCfg easyToRemember​(java.lang.Boolean easyToRemember)
      • getEasyToRemember

        @Nullable
        public java.lang.Boolean getEasyToRemember()
        If true, every second letter will be the same, that allows the codes to rhyme.
        Returns:
        easyToRemember
      • setEasyToRemember

        public void setEasyToRemember​(java.lang.Boolean easyToRemember)
      • maxAttempts

        public CodeCfg maxAttempts​(java.lang.Integer maxAttempts)
      • getMaxAttempts

        @Nullable
        public java.lang.Integer getMaxAttempts()
        Max attempts to enter the code.
        Returns:
        maxAttempts
      • setMaxAttempts

        public void setMaxAttempts​(java.lang.Integer maxAttempts)
      • putAdditionalProperty

        public CodeCfg 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 CodeCfg
      • fromJson

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

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