Package io.lakefs.clients.sdk.model
Class LoginConfig
- java.lang.Object
-
- io.lakefs.clients.sdk.model.LoginConfig
-
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class LoginConfig extends Object
LoginConfig
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classLoginConfig.CustomTypeAdapterFactorystatic classLoginConfig.RBACEnumRBAC will remain enabled on GUI if \"external\".
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>openapiFieldsstatic HashSet<String>openapiRequiredFieldsstatic StringSERIALIZED_NAME_FALLBACK_LOGIN_LABELstatic StringSERIALIZED_NAME_FALLBACK_LOGIN_URLstatic StringSERIALIZED_NAME_LOGIN_COOKIE_NAMESstatic StringSERIALIZED_NAME_LOGIN_FAILED_MESSAGEstatic StringSERIALIZED_NAME_LOGIN_URLstatic StringSERIALIZED_NAME_LOGOUT_URLstatic StringSERIALIZED_NAME_R_B_A_C
-
Constructor Summary
Constructors Constructor Description LoginConfig()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description LoginConfigaddLoginCookieNamesItem(String loginCookieNamesItem)booleanequals(Object o)LoginConfigfallbackLoginLabel(String fallbackLoginLabel)LoginConfigfallbackLoginUrl(String fallbackLoginUrl)static LoginConfigfromJson(String jsonString)Create an instance of LoginConfig given an JSON stringMap<String,Object>getAdditionalProperties()Return the additional (undeclared) property.ObjectgetAdditionalProperty(String key)Return the additional (undeclared) property with the specified name.StringgetFallbackLoginLabel()label to place on fallback_login_url.StringgetFallbackLoginUrl()secondary URL to offer users to use for login.List<String>getLoginCookieNames()cookie names used to store JWTStringgetLoginFailedMessage()message to display to users who fail to login; a full sentence that is rendered in HTML and may contain a link to a secondary login methodStringgetLoginUrl()primary URL to use for login.StringgetLogoutUrl()URL to use for logging out.LoginConfig.RBACEnumgetRBAC()RBAC will remain enabled on GUI if \"external\".inthashCode()LoginConfigloginCookieNames(List<String> loginCookieNames)LoginConfigloginFailedMessage(String loginFailedMessage)LoginConfigloginUrl(String loginUrl)LoginConfiglogoutUrl(String logoutUrl)LoginConfigputAdditionalProperty(String key, Object value)Set the additional (undeclared) property with the specified name and value.LoginConfigRBAC(LoginConfig.RBACEnum RBAC)voidsetFallbackLoginLabel(String fallbackLoginLabel)voidsetFallbackLoginUrl(String fallbackLoginUrl)voidsetLoginCookieNames(List<String> loginCookieNames)voidsetLoginFailedMessage(String loginFailedMessage)voidsetLoginUrl(String loginUrl)voidsetLogoutUrl(String logoutUrl)voidsetRBAC(LoginConfig.RBACEnum RBAC)StringtoJson()Convert an instance of LoginConfig to an JSON stringStringtoString()static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement)Validates the JSON Element and throws an exception if issues found
-
-
-
Field Detail
-
SERIALIZED_NAME_R_B_A_C
public static final String SERIALIZED_NAME_R_B_A_C
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LOGIN_URL
public static final String SERIALIZED_NAME_LOGIN_URL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LOGIN_FAILED_MESSAGE
public static final String SERIALIZED_NAME_LOGIN_FAILED_MESSAGE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FALLBACK_LOGIN_URL
public static final String SERIALIZED_NAME_FALLBACK_LOGIN_URL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FALLBACK_LOGIN_LABEL
public static final String SERIALIZED_NAME_FALLBACK_LOGIN_LABEL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LOGIN_COOKIE_NAMES
public static final String SERIALIZED_NAME_LOGIN_COOKIE_NAMES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LOGOUT_URL
public static final String SERIALIZED_NAME_LOGOUT_URL
- See Also:
- Constant Field Values
-
-
Method Detail
-
RBAC
public LoginConfig RBAC(LoginConfig.RBACEnum RBAC)
-
getRBAC
@Nullable public LoginConfig.RBACEnum getRBAC()
RBAC will remain enabled on GUI if \"external\". That only works with an external auth service.- Returns:
- RBAC
-
setRBAC
public void setRBAC(LoginConfig.RBACEnum RBAC)
-
loginUrl
public LoginConfig loginUrl(String loginUrl)
-
setLoginUrl
public void setLoginUrl(String loginUrl)
-
loginFailedMessage
public LoginConfig loginFailedMessage(String loginFailedMessage)
-
getLoginFailedMessage
@Nullable public String getLoginFailedMessage()
message to display to users who fail to login; a full sentence that is rendered in HTML and may contain a link to a secondary login method- Returns:
- loginFailedMessage
-
setLoginFailedMessage
public void setLoginFailedMessage(String loginFailedMessage)
-
fallbackLoginUrl
public LoginConfig fallbackLoginUrl(String fallbackLoginUrl)
-
getFallbackLoginUrl
@Nullable public String getFallbackLoginUrl()
secondary URL to offer users to use for login.- Returns:
- fallbackLoginUrl
-
setFallbackLoginUrl
public void setFallbackLoginUrl(String fallbackLoginUrl)
-
fallbackLoginLabel
public LoginConfig fallbackLoginLabel(String fallbackLoginLabel)
-
getFallbackLoginLabel
@Nullable public String getFallbackLoginLabel()
label to place on fallback_login_url.- Returns:
- fallbackLoginLabel
-
setFallbackLoginLabel
public void setFallbackLoginLabel(String fallbackLoginLabel)
-
loginCookieNames
public LoginConfig loginCookieNames(List<String> loginCookieNames)
-
addLoginCookieNamesItem
public LoginConfig addLoginCookieNamesItem(String loginCookieNamesItem)
-
getLoginCookieNames
@Nonnull public List<String> getLoginCookieNames()
cookie names used to store JWT- Returns:
- loginCookieNames
-
logoutUrl
public LoginConfig logoutUrl(String logoutUrl)
-
setLogoutUrl
public void setLogoutUrl(String logoutUrl)
-
putAdditionalProperty
public LoginConfig putAdditionalProperty(String key, 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.- Parameters:
key- name of the propertyvalue- value of the property- Returns:
- the LoginConfig instance itself
-
getAdditionalProperties
public Map<String,Object> getAdditionalProperties()
Return the additional (undeclared) property.- Returns:
- a map of objects
-
getAdditionalProperty
public Object getAdditionalProperty(String key)
Return the additional (undeclared) property with the specified name.- Parameters:
key- name of the property- Returns:
- an object
-
validateJsonElement
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOExceptionValidates the JSON Element and throws an exception if issues found- Parameters:
jsonElement- JSON Element- Throws:
IOException- if the JSON Element is invalid with respect to LoginConfig
-
fromJson
public static LoginConfig fromJson(String jsonString) throws IOException
Create an instance of LoginConfig given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of LoginConfig
- Throws:
IOException- if the JSON string is invalid with respect to LoginConfig
-
toJson
public String toJson()
Convert an instance of LoginConfig to an JSON string- Returns:
- JSON string
-
-