com.softlayer.api.service.container.authentication.request.Native Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.container.authentication.request;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.container.authentication.request.Common;

/**
 * The SoftLayer_Container_Authentication_Request_Native data type contains information for requests to the getPortalLogin API. This class is specific to the SoftLayer Native login (username/password). The request information will be verified to ensure it is valid, and then there will be an attempt to obtain a portal login token in authenticating the user with the provided information. 
 *
 * @see SoftLayer_Container_Authentication_Request_Native
 */
@ApiType("SoftLayer_Container_Authentication_Request_Native")
public class Native extends Common {

    @ApiProperty(canBeNullOrNotSet = true)
    protected String auxiliaryClaimsMiniToken;

    public String getAuxiliaryClaimsMiniToken() {
        return auxiliaryClaimsMiniToken;
    }

    public void setAuxiliaryClaimsMiniToken(String auxiliaryClaimsMiniToken) {
        auxiliaryClaimsMiniTokenSpecified = true;
        this.auxiliaryClaimsMiniToken = auxiliaryClaimsMiniToken;
    }

    protected boolean auxiliaryClaimsMiniTokenSpecified;

    public boolean isAuxiliaryClaimsMiniTokenSpecified() {
        return auxiliaryClaimsMiniTokenSpecified;
    }

    public void unsetAuxiliaryClaimsMiniToken() {
        auxiliaryClaimsMiniToken = null;
        auxiliaryClaimsMiniTokenSpecified = false;
    }

    /**
     * Your SoftLayer customer portal user's portal password.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String password;

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        passwordSpecified = true;
        this.password = password;
    }

    protected boolean passwordSpecified;

    public boolean isPasswordSpecified() {
        return passwordSpecified;
    }

    public void unsetPassword() {
        password = null;
        passwordSpecified = false;
    }

    /**
     * The username you wish to authenticate to the SoftLayer customer portal with.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String username;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        usernameSpecified = true;
        this.username = username;
    }

    protected boolean usernameSpecified;

    public boolean isUsernameSpecified() {
        return usernameSpecified;
    }

    public void unsetUsername() {
        username = null;
        usernameSpecified = false;
    }

    public static class Mask extends Common.Mask {

        public Mask auxiliaryClaimsMiniToken() {
            withLocalProperty("auxiliaryClaimsMiniToken");
            return this;
        }

        public Mask password() {
            withLocalProperty("password");
            return this;
        }

        public Mask username() {
            withLocalProperty("username");
            return this;
        }

    }

}