com.softlayer.api.service.container.user.customer.external.Binding 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.user.customer.external;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;

/**
 * Container classed used to hold external authentication information 
 *
 * @see SoftLayer_Container_User_Customer_External_Binding
 */
@ApiType("SoftLayer_Container_User_Customer_External_Binding")
public class Binding extends Entity {

    /**
     * The unique token that is created by an external authentication request.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String authenticationToken;

    public String getAuthenticationToken() {
        return authenticationToken;
    }

    public void setAuthenticationToken(String authenticationToken) {
        authenticationTokenSpecified = true;
        this.authenticationToken = authenticationToken;
    }

    protected boolean authenticationTokenSpecified;

    public boolean isAuthenticationTokenSpecified() {
        return authenticationTokenSpecified;
    }

    public void unsetAuthenticationToken() {
        authenticationToken = null;
        authenticationTokenSpecified = false;
    }

    /**
     * The OpenID Connect access token which provides access to a resource by the OpenID Connect provider.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String openIdConnectAccessToken;

    public String getOpenIdConnectAccessToken() {
        return openIdConnectAccessToken;
    }

    public void setOpenIdConnectAccessToken(String openIdConnectAccessToken) {
        openIdConnectAccessTokenSpecified = true;
        this.openIdConnectAccessToken = openIdConnectAccessToken;
    }

    protected boolean openIdConnectAccessTokenSpecified;

    public boolean isOpenIdConnectAccessTokenSpecified() {
        return openIdConnectAccessTokenSpecified;
    }

    public void unsetOpenIdConnectAccessToken() {
        openIdConnectAccessToken = null;
        openIdConnectAccessTokenSpecified = false;
    }

    /**
     * The account to login to, if not provided a default will be used.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long openIdConnectAccountId;

    public Long getOpenIdConnectAccountId() {
        return openIdConnectAccountId;
    }

    public void setOpenIdConnectAccountId(Long openIdConnectAccountId) {
        openIdConnectAccountIdSpecified = true;
        this.openIdConnectAccountId = openIdConnectAccountId;
    }

    protected boolean openIdConnectAccountIdSpecified;

    public boolean isOpenIdConnectAccountIdSpecified() {
        return openIdConnectAccountIdSpecified;
    }

    public void unsetOpenIdConnectAccountId() {
        openIdConnectAccountId = null;
        openIdConnectAccountIdSpecified = false;
    }

    /**
     * The OpenID Connect provider type, as a string.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String openIdConnectProvider;

    public String getOpenIdConnectProvider() {
        return openIdConnectProvider;
    }

    public void setOpenIdConnectProvider(String openIdConnectProvider) {
        openIdConnectProviderSpecified = true;
        this.openIdConnectProvider = openIdConnectProvider;
    }

    protected boolean openIdConnectProviderSpecified;

    public boolean isOpenIdConnectProviderSpecified() {
        return openIdConnectProviderSpecified;
    }

    public void unsetOpenIdConnectProvider() {
        openIdConnectProvider = null;
        openIdConnectProviderSpecified = 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 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;
    }

    /**
     * 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;
    }

    /**
     * The name of the vendor that will be used for external authentication
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String vendor;

    public String getVendor() {
        return vendor;
    }

    public void setVendor(String vendor) {
        vendorSpecified = true;
        this.vendor = vendor;
    }

    protected boolean vendorSpecified;

    public boolean isVendorSpecified() {
        return vendorSpecified;
    }

    public void unsetVendor() {
        vendor = null;
        vendorSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

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

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

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

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

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

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

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

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

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

    }

}