com.softlayer.api.service.account.authentication.Attribute 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.account.authentication;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.account.authentication.Saml;
import com.softlayer.api.service.account.authentication.attribute.Type;
import java.util.concurrent.Future;

/**
 * Account authentication has many different settings that can be set. This class allows the customer or employee to set these settigns. 
 *
 * @see SoftLayer_Account_Authentication_Attribute
 */
@ApiType("SoftLayer_Account_Authentication_Attribute")
public class Attribute extends Entity {

    /**
     * The SoftLayer customer account.
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

    public void setAccount(Account account) {
        this.account = account;
    }

    /**
     * The SoftLayer account authentication that has an attribute.
     */
    @ApiProperty
    protected Saml authenticationRecord;

    public Saml getAuthenticationRecord() {
        return authenticationRecord;
    }

    public void setAuthenticationRecord(Saml authenticationRecord) {
        this.authenticationRecord = authenticationRecord;
    }

    /**
     * The type of attribute assigned to a SoftLayer account authentication.
     */
    @ApiProperty
    protected Type type;

    public Type getType() {
        return type;
    }

    public void setType(Type type) {
        this.type = type;
    }

    /**
     * The internal identifier of the SoftLayer customer account that is assigned an account authenction attribute. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long accountId;

    public Long getAccountId() {
        return accountId;
    }

    public void setAccountId(Long accountId) {
        accountIdSpecified = true;
        this.accountId = accountId;
    }

    protected boolean accountIdSpecified;

    public boolean isAccountIdSpecified() {
        return accountIdSpecified;
    }

    public void unsetAccountId() {
        accountId = null;
        accountIdSpecified = false;
    }

    /**
     * A SoftLayer account authenction attribute's internal identifier. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * The internal identifier of the type of attribute that a SoftLayer account authenction attribute belongs to. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long typeId;

    public Long getTypeId() {
        return typeId;
    }

    public void setTypeId(Long typeId) {
        typeIdSpecified = true;
        this.typeId = typeId;
    }

    protected boolean typeIdSpecified;

    public boolean isTypeIdSpecified() {
        return typeIdSpecified;
    }

    public void unsetTypeId() {
        typeId = null;
        typeIdSpecified = false;
    }

    /**
     * A SoftLayer account authenction attribute's value. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String value;

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        valueSpecified = true;
        this.value = value;
    }

    protected boolean valueSpecified;

    public boolean isValueSpecified() {
        return valueSpecified;
    }

    public void unsetValue() {
        value = null;
        valueSpecified = false;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * @see SoftLayer_Account_Authentication_Attribute
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Account_Authentication_Attribute")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * @see SoftLayer_Account_Authentication_Attribute::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Attribute getObject();

        /**
         * The SoftLayer customer account.
         *
         * @see SoftLayer_Account_Authentication_Attribute::getAccount
         */
        @ApiMethod(instanceRequired = true)
        public Account getAccount();

        /**
         * The SoftLayer account authentication that has an attribute.
         *
         * @see SoftLayer_Account_Authentication_Attribute::getAuthenticationRecord
         */
        @ApiMethod(instanceRequired = true)
        public Saml getAuthenticationRecord();

        /**
         * The type of attribute assigned to a SoftLayer account authentication.
         *
         * @see SoftLayer_Account_Authentication_Attribute::getType
         */
        @ApiMethod(instanceRequired = true)
        public Type getType();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

        /**
         * Async version of {@link Service#getAccount}
         */
        public Future getAccount();

        /**
         * Async callback version of {@link Service#getAccount}
         */
        public Future getAccount(ResponseHandler callback);

        /**
         * Async version of {@link Service#getAuthenticationRecord}
         */
        public Future getAuthenticationRecord();

        /**
         * Async callback version of {@link Service#getAuthenticationRecord}
         */
        public Future getAuthenticationRecord(ResponseHandler callback);

        /**
         * Async version of {@link Service#getType}
         */
        public Future getType();

        /**
         * Async callback version of {@link Service#getType}
         */
        public Future getType(ResponseHandler callback);

    }

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

        public com.softlayer.api.service.Account.Mask account() {
            return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
        }

        public Saml.Mask authenticationRecord() {
            return withSubMask("authenticationRecord", Saml.Mask.class);
        }

        public com.softlayer.api.service.account.authentication.attribute.Type.Mask type() {
            return withSubMask("type", com.softlayer.api.service.account.authentication.attribute.Type.Mask.class);
        }

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

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

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

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

    }

}