com.softlayer.api.service.provisioning.version1.transaction.Group 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.provisioning.version1.transaction;

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 java.math.BigDecimal;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Provisioning_Version1_Transaction_Group data type contains general information relating to a single SoftLayer hardware transaction group. 

 * 

 * SoftLayer customers are unable to change their hardware transactions or the hardware transaction group. 
 *
 * @see SoftLayer_Provisioning_Version1_Transaction_Group
 */
@ApiType("SoftLayer_Provisioning_Version1_Transaction_Group")
public class Group extends Entity {

    /**
     * Average time, in minutes, for this type of transaction to complete. Please note that this is only an estimate. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal averageTimeToComplete;

    public BigDecimal getAverageTimeToComplete() {
        return averageTimeToComplete;
    }

    public void setAverageTimeToComplete(BigDecimal averageTimeToComplete) {
        averageTimeToCompleteSpecified = true;
        this.averageTimeToComplete = averageTimeToComplete;
    }

    protected boolean averageTimeToCompleteSpecified;

    public boolean isAverageTimeToCompleteSpecified() {
        return averageTimeToCompleteSpecified;
    }

    public void unsetAverageTimeToComplete() {
        averageTimeToComplete = null;
        averageTimeToCompleteSpecified = false;
    }

    /**
     * A transaction group's name.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        nameSpecified = true;
        this.name = name;
    }

    protected boolean nameSpecified;

    public boolean isNameSpecified() {
        return nameSpecified;
    }

    public void unsetName() {
        name = null;
        nameSpecified = false;
    }

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

    /**
     * The service lists the different types of transactions. This includes operating system reloads and new operating system provisions. 
     *
     * @see SoftLayer_Provisioning_Version1_Transaction_Group
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Provisioning_Version1_Transaction_Group")
    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_Provisioning_Version1_Transaction_Group::getAllObjects
         */
        @ApiMethod
        public List getAllObjects();

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

    }

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

        public Future getAllObjects(ResponseHandler> callback);

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

        public Future getObject(ResponseHandler callback);

    }

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

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

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

    }

}