Package app.kntrl.client.openapi.model

Class RemoteAuthCfg

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class RemoteAuthCfg
extends java.lang.Object
    Authentication implementation config

    • Field Detail

      • SERIALIZED_NAME_REMOTE

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

      • SERIALIZED_NAME_REQUIRES_AUTH

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

      • SERIALIZED_NAME_SKIP_ON_FAIL

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

      • SERIALIZED_NAME_RATE_LIMITER

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

      • SERIALIZED_NAME_BURN_QUOTA

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

      • SERIALIZED_NAME_QUERY

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

      • SERIALIZED_NAME_HEADERS

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

      • SERIALIZED_NAME_CODE

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

      • RemoteAuthCfg

        public RemoteAuthCfg()

    • Method Detail

      • remote

        public RemoteAuthCfg remote​(java.lang.String remote)

      • getRemote

        @Nonnull
public java.lang.String getRemote()
        Path to the API that implements plugin.
        Returns:
        remote

      • setRemote

        public void setRemote​(java.lang.String remote)

      • requiresAuth

        public RemoteAuthCfg requiresAuth​(java.util.List<java.util.List<java.lang.String>> requiresAuth)

      • addRequiresAuthItem

        public RemoteAuthCfg addRequiresAuthItem​(java.util.List<java.lang.String> requiresAuthItem)

      • getRequiresAuth

        @Nullable
public java.util.List<java.util.List<java.lang.String>> getRequiresAuth()
        If this is not null, app forbids to add this auth until listed auth enabled. - if this a string -> require specified auth to be enabled before this. - array of strings -> require any of listed auths to be enabled - array of arrays of strings -> works as `[ [ \"auth1\" and \"auth2\" ] or [ \"auth1\" and \"auth2\" ] ]`
        Returns:
        requiresAuth

      • setRequiresAuth

        public void setRequiresAuth​(java.util.List<java.util.List<java.lang.String>> requiresAuth)

      • skipOnFail

        public RemoteAuthCfg skipOnFail​(java.lang.Boolean skipOnFail)

      • getSkipOnFail

        @Nullable
public java.lang.Boolean getSkipOnFail()
        When this is set to true app will attempt next auth in case of error on current. It's works good with IP auth. User can provide both IP auth request and SMS auth request. And SMS will be executed only when IP auth is failed. If set to false any error on this auth will stop the whole request execution.
        Returns:
        skipOnFail

      • setSkipOnFail

        public void setSkipOnFail​(java.lang.Boolean skipOnFail)

      • rateLimiter

        public RemoteAuthCfg rateLimiter​(java.lang.String rateLimiter)

      • getRateLimiter

        @Nullable
public java.lang.String getRateLimiter()
        Apply rate limiter for this auth.
        Returns:
        rateLimiter

      • setRateLimiter

        public void setRateLimiter​(java.lang.String rateLimiter)

      • burnQuota

        public RemoteAuthCfg burnQuota​(java.lang.Double burnQuota)

      • getBurnQuota

        @Nullable
public java.lang.Double getBurnQuota()
        Every auth execution will burn this amount of quota. Takes place only when rate limiter is specified
        Returns:
        burnQuota

      • setBurnQuota

        public void setBurnQuota​(java.lang.Double burnQuota)

      • query

        public RemoteAuthCfg query​(java.util.Map<java.lang.String,​java.lang.String> query)

      • putQueryItem

        public RemoteAuthCfg putQueryItem​(java.lang.String key,
                                  java.lang.String queryItem)

      • getQuery

        @Nullable
public java.util.Map<java.lang.String,​java.lang.String> getQuery()
        Add query params after `?` symbol in url.
        Returns:
        query

      • setQuery

        public void setQuery​(java.util.Map<java.lang.String,​java.lang.String> query)

      • headers

        public RemoteAuthCfg headers​(java.util.Map<java.lang.String,​java.lang.String> headers)

      • putHeadersItem

        public RemoteAuthCfg putHeadersItem​(java.lang.String key,
                                    java.lang.String headersItem)

      • getHeaders

        @Nullable
public java.util.Map<java.lang.String,​java.lang.String> getHeaders()
        Add headers to request.
        Returns:
        headers

      • setHeaders

        public void setHeaders​(java.util.Map<java.lang.String,​java.lang.String> headers)

      • getCode

        @Nullable
public CodeCfg getCode()
        Get code
        Returns:
        code

      • setCode

        public void setCode​(CodeCfg code)

      • putAdditionalProperty

        public RemoteAuthCfg 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 RemoteAuthCfg

      • fromJson

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

      • toJson

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