com.softlayer.api.service.hardware.benchmark.Certification 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.hardware.benchmark;

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.Hardware;
import java.util.GregorianCalendar;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Hardware_Benchmark_Certification data type contains general information relating to a single SoftLayer hardware benchmark certification document. 
 *
 * @see SoftLayer_Hardware_Benchmark_Certification
 */
@ApiType("SoftLayer_Hardware_Benchmark_Certification")
public class Certification extends Entity {

    /**
     * Information regarding a benchmark certification result's associated SoftLayer customer account.
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

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

    /**
     * Information regarding the piece of hardware on which a benchmark certification test was performed.
     */
    @ApiProperty
    protected Hardware hardware;

    public Hardware getHardware() {
        return hardware;
    }

    public void setHardware(Hardware hardware) {
        this.hardware = hardware;
    }

    /**
     * The internal identifier of the SoftLayer customer account associated with a benchmark certification result.
     */
    @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;
    }

    /**
     * The date that a benchmark certification result was generated.
     */
    @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;
    }

    /**
     * A benchmark certification results's associated hardware's internal identification number.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long hardwareId;

    public Long getHardwareId() {
        return hardwareId;
    }

    public void setHardwareId(Long hardwareId) {
        hardwareIdSpecified = true;
        this.hardwareId = hardwareId;
    }

    protected boolean hardwareIdSpecified;

    public boolean isHardwareIdSpecified() {
        return hardwareIdSpecified;
    }

    public void unsetHardwareId() {
        hardwareId = null;
        hardwareIdSpecified = false;
    }

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

    /**
     * This certification is used to indicate the date, time and validity of the benchmark certification process. The certification process includes running a battery of tests on all major sub-systems of a server in order to verify that all components of the server are functioning up to specification. Only after a server has passed each and every hardware and configuration test will it be provisioned for a customer. The "SoftLayer_Hardware_Benchmark_Certification" class is used to indicate the date, time and validity of the benchmark certification process. This process includes running a battery of tests on all major sub-systems of a server to verify that all components of the server are functioning according to their specifications. Once each server has passed all hardware and configurations tests, it is provisioned to a SoftLayer customer. 
     *
     * @see SoftLayer_Hardware_Benchmark_Certification
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Hardware_Benchmark_Certification")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * getObject retrieves the SoftLayer_Hardware_Benchmark_Certification object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware_Benchmark_Certification service. 
         *
         * @see SoftLayer_Hardware_Benchmark_Certification::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Certification getObject();

        /**
         * Attempt to retrieve the file associated with a benchmark certification result, if such a file exists.  If there is no file for this benchmark certification result, calling this method throws an exception. The "getResultFile" method attempts to retrieve the file associated with a benchmark certification result, if such a file exists. If no file exists for the benchmark certification, an exception is thrown. 
         *
         * @see SoftLayer_Hardware_Benchmark_Certification::getResultFile
         */
        @ApiMethod(instanceRequired = true)
        public byte[] getResultFile();

        /**
         * Information regarding a benchmark certification result's associated SoftLayer customer account.
         *
         * @see SoftLayer_Hardware_Benchmark_Certification::getAccount
         */
        @ApiMethod(instanceRequired = true)
        public Account getAccount();

        /**
         * Information regarding the piece of hardware on which a benchmark certification test was performed.
         *
         * @see SoftLayer_Hardware_Benchmark_Certification::getHardware
         */
        @ApiMethod(instanceRequired = true)
        public Hardware getHardware();

    }

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

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

        /**
         * Async callback version of {@link Service#getHardware}
         */
        public Future getHardware(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 com.softlayer.api.service.Hardware.Mask hardware() {
            return withSubMask("hardware", com.softlayer.api.service.Hardware.Mask.class);
        }

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

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

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

    }

}