com.softlayer.api.service.container.authentication.response.Success 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

The newest version!

package com.softlayer.api.service.container.authentication.response;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.container.authentication.response.Common;
import com.softlayer.api.service.container.user.authentication.Token;

/**
 * The SoftLayer_Container_Authentication_Response_SUCCESS data type contains information for specific responses from the getPortalLogin API. This class is indicative of a request that was successful in obtaining a portal login token from the getPortalLogin API. 
 *
 * @see SoftLayer_Container_Authentication_Response_Success
 */
@ApiType("SoftLayer_Container_Authentication_Response_Success")
public class Success extends Common {

    @ApiProperty(canBeNullOrNotSet = true)
    protected String statusKeyName;

    public String getStatusKeyName() {
        return statusKeyName;
    }

    public void setStatusKeyName(String statusKeyName) {
        statusKeyNameSpecified = true;
        this.statusKeyName = statusKeyName;
    }

    protected boolean statusKeyNameSpecified;

    public boolean isStatusKeyNameSpecified() {
        return statusKeyNameSpecified;
    }

    public void unsetStatusKeyName() {
        statusKeyName = null;
        statusKeyNameSpecified = false;
    }

    /**
     * The token for interacting with the SoftLayer customer portal.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Token token;

    public Token getToken() {
        return token;
    }

    public void setToken(Token token) {
        tokenSpecified = true;
        this.token = token;
    }

    protected boolean tokenSpecified;

    public boolean isTokenSpecified() {
        return tokenSpecified;
    }

    public void unsetToken() {
        token = null;
        tokenSpecified = false;
    }

    public static class Mask extends Common.Mask {

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

        public com.softlayer.api.service.container.user.authentication.Token.Mask token() {
            return withSubMask("token", com.softlayer.api.service.container.user.authentication.Token.Mask.class);
        }

    }

}