com.softlayer.api.service.container.authentication.request.Common 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.Contract;

/**
 * The SoftLayer_Container_Authentication_Request_Common data type contains common information for requests to the getPortalLogin API. This is an abstract class that serves as a base that more specialized classes will derive from. For example, a request class specific to SoftLayer Native IMS Login (username and password). 
 *
 * @see SoftLayer_Container_Authentication_Request_Common
 */
@ApiType("SoftLayer_Container_Authentication_Request_Common")
public class Common extends Contract {

    /**
     * The answer to your security question.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String securityQuestionAnswer;

    public String getSecurityQuestionAnswer() {
        return securityQuestionAnswer;
    }

    public void setSecurityQuestionAnswer(String securityQuestionAnswer) {
        securityQuestionAnswerSpecified = true;
        this.securityQuestionAnswer = securityQuestionAnswer;
    }

    protected boolean securityQuestionAnswerSpecified;

    public boolean isSecurityQuestionAnswerSpecified() {
        return securityQuestionAnswerSpecified;
    }

    public void unsetSecurityQuestionAnswer() {
        securityQuestionAnswer = null;
        securityQuestionAnswerSpecified = false;
    }

    /**
     * A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn't required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long securityQuestionId;

    public Long getSecurityQuestionId() {
        return securityQuestionId;
    }

    public void setSecurityQuestionId(Long securityQuestionId) {
        securityQuestionIdSpecified = true;
        this.securityQuestionId = securityQuestionId;
    }

    protected boolean securityQuestionIdSpecified;

    public boolean isSecurityQuestionIdSpecified() {
        return securityQuestionIdSpecified;
    }

    public void unsetSecurityQuestionId() {
        securityQuestionId = null;
        securityQuestionIdSpecified = false;
    }

    public static class Mask extends Contract.Mask {

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

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

    }

}