com.softlayer.api.service.user.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
The newest version!
package com.softlayer.api.service.user.external;

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.Entity;
import com.softlayer.api.service.billing.Item;
import com.softlayer.api.service.user.external.binding.Attribute;
import com.softlayer.api.service.user.external.binding.Type;
import com.softlayer.api.service.user.external.binding.Vendor;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_User_External_Binding data type contains general information for a single external binding.  This includes the 3rd party vendor, type of binding, and a unique identifier and password that is used to authenticate against the 3rd party service. 
 *
 * @see SoftLayer_User_External_Binding
 */
@ApiType("SoftLayer_User_External_Binding")
public class Binding extends Entity {

    /**
     * Attributes of an external authentication binding.
     */
    @ApiProperty
    protected List attributes;

    public List getAttributes() {
        if (attributes == null) {
            attributes = new ArrayList();
        }
        return attributes;
    }

    /**
     * Information regarding the billing item for external authentication.
     */
    @ApiProperty
    protected Item billingItem;

    public Item getBillingItem() {
        return billingItem;
    }

    public void setBillingItem(Item billingItem) {
        this.billingItem = billingItem;
    }

    /**
     * An optional note for identifying the external binding.
     */
    @ApiProperty
    protected String note;

    public String getNote() {
        return note;
    }

    public void setNote(String note) {
        this.note = note;
    }

    /**
     * The type of external authentication binding.
     */
    @ApiProperty
    protected Type type;

    public Type getType() {
        return type;
    }

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

    /**
     * The vendor of an external authentication binding.
     */
    @ApiProperty
    protected Vendor vendor;

    public Vendor getVendor() {
        return vendor;
    }

    public void setVendor(Vendor vendor) {
        this.vendor = vendor;
    }

    /**
     * The flag that determines whether the external binding is active will be used for authentication or not. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean active;

    public Boolean getActive() {
        return active;
    }

    public void setActive(Boolean active) {
        activeSpecified = true;
        this.active = active;
    }

    protected boolean activeSpecified;

    public boolean isActiveSpecified() {
        return activeSpecified;
    }

    public void unsetActive() {
        active = null;
        activeSpecified = false;
    }

    /**
     * The date that the external authentication binding was created.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar createDate;

    public GregorianCalendar getCreateDate() {
        return createDate;
    }

    public void setCreateDate(GregorianCalendar createDate) {
        createDateSpecified = true;
        this.createDate = createDate;
    }

    protected boolean createDateSpecified;

    public boolean isCreateDateSpecified() {
        return createDateSpecified;
    }

    public void unsetCreateDate() {
        createDate = null;
        createDateSpecified = false;
    }

    /**
     * The identifier used to identify this binding to an external authentication source. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String externalId;

    public String getExternalId() {
        return externalId;
    }

    public void setExternalId(String externalId) {
        externalIdSpecified = true;
        this.externalId = externalId;
    }

    protected boolean externalIdSpecified;

    public boolean isExternalIdSpecified() {
        return externalIdSpecified;
    }

    public void unsetExternalId() {
        externalId = null;
        externalIdSpecified = false;
    }

    /**
     * An external authentication binding'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 password used to authenticate the external id at an external authentication source. 
     */
    @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 [[SoftLayer_User_External_Binding_Type|type]] identifier of an external authentication binding. 
     */
    @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;
    }

    /**
     * An external authentication binding's associated [[SoftLayer_User_Customer|user account]] id. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long userId;

    public Long getUserId() {
        return userId;
    }

    public void setUserId(Long userId) {
        userIdSpecified = true;
        this.userId = userId;
    }

    protected boolean userIdSpecified;

    public boolean isUserIdSpecified() {
        return userIdSpecified;
    }

    public void unsetUserId() {
        userId = null;
        userIdSpecified = false;
    }

    /**
     * The [[SoftLayer_User_External_Binding_Vendor|vendor]] identifier of an external authentication binding. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long vendorId;

    public Long getVendorId() {
        return vendorId;
    }

    public void setVendorId(Long vendorId) {
        vendorIdSpecified = true;
        this.vendorId = vendorId;
    }

    protected boolean vendorIdSpecified;

    public boolean isVendorIdSpecified() {
        return vendorIdSpecified;
    }

    public void unsetVendorId() {
        vendorId = null;
        vendorIdSpecified = false;
    }

    /**
     * A count of attributes of an external authentication binding.
     */
    @ApiProperty
    protected Long attributeCount;

    public Long getAttributeCount() {
        return attributeCount;
    }

    public void setAttributeCount(Long attributeCount) {
        this.attributeCount = attributeCount;
    }

    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_User_External_Binding
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_User_External_Binding")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * Delete an external authentication binding.  If the external binding currently has an active billing item associated you will be prevented from deleting the binding.  The alternative method to remove an external authentication binding is to use the service cancellation form. 
         *
         * @see SoftLayer_User_External_Binding::deleteObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean deleteObject();

        /**
         * @see SoftLayer_User_External_Binding::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Binding getObject();

        /**
         * Update the note of an external binding.  The note is an optional property that is used to store information about a binding. 
         *
         * @see SoftLayer_User_External_Binding::updateNote
         */
        @ApiMethod(instanceRequired = true)
        public Boolean updateNote(String text);

        /**
         * Attributes of an external authentication binding.
         *
         * @see SoftLayer_User_External_Binding::getAttributes
         */
        @ApiMethod(instanceRequired = true)
        public List getAttributes();

        /**
         * Information regarding the billing item for external authentication.
         *
         * @see SoftLayer_User_External_Binding::getBillingItem
         */
        @ApiMethod(instanceRequired = true)
        public Item getBillingItem();

        /**
         * An optional note for identifying the external binding.
         *
         * @see SoftLayer_User_External_Binding::getNote
         */
        @ApiMethod(instanceRequired = true)
        public String getNote();

        /**
         * The type of external authentication binding.
         *
         * @see SoftLayer_User_External_Binding::getType
         */
        @ApiMethod(instanceRequired = true)
        public Type getType();

        /**
         * The vendor of an external authentication binding.
         *
         * @see SoftLayer_User_External_Binding::getVendor
         */
        @ApiMethod(instanceRequired = true)
        public Vendor getVendor();

    }

    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#deleteObject}
         */
        public Future deleteObject();

        public Future deleteObject(ResponseHandler callback);

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

        public Future getObject(ResponseHandler callback);

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

        public Future updateNote(String text, ResponseHandler callback);

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

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

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

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

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

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

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

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

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

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

    }

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

        public com.softlayer.api.service.user.external.binding.Attribute.Mask attributes() {
            return withSubMask("attributes", com.softlayer.api.service.user.external.binding.Attribute.Mask.class);
        }

        public com.softlayer.api.service.billing.Item.Mask billingItem() {
            return withSubMask("billingItem", com.softlayer.api.service.billing.Item.Mask.class);
        }

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

        public com.softlayer.api.service.user.external.binding.Type.Mask type() {
            return withSubMask("type", com.softlayer.api.service.user.external.binding.Type.Mask.class);
        }

        public com.softlayer.api.service.user.external.binding.Vendor.Mask vendor() {
            return withSubMask("vendor", com.softlayer.api.service.user.external.binding.Vendor.Mask.class);
        }

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

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

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

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

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

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

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

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

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

    }

}