• Home
• com.softlayer.api
• softlayer-api-client
• 0.2.0
• source code
• Schedule.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.softlayer.api.service.network.storage.Schedule Maven / Gradle / Ivy

package com.softlayer.api.service.network.storage;

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.network.Storage;
import com.softlayer.api.service.network.storage.Event;
import com.softlayer.api.service.network.storage.Partnership;
import com.softlayer.api.service.network.storage.schedule.Property;
import com.softlayer.api.service.network.storage.schedule.Type;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * Schedules can be created for select Storage services, such as iscsi. These schedules are used to perform various tasks such as scheduling snapshots or synchronizing replicants. 
 *
 * @see SoftLayer_Network_Storage_Schedule
 */
@ApiType("SoftLayer_Network_Storage_Schedule")
public class Schedule extends Entity {

    /**
     * Events which have been created as the result of a schedule execution.
     */
    @ApiProperty
    protected List events;

    public List getEvents() {
        if (events == null) {
            events = new ArrayList();
        }
        return events;
    }

    /**
     * The associated partnership for a schedule.
     */
    @ApiProperty
    protected Partnership partnership;

    public Partnership getPartnership() {
        return partnership;
    }

    public void setPartnership(Partnership partnership) {
        this.partnership = partnership;
    }

    /**
     * Properties used for configuration of a schedule.
     */
    @ApiProperty
    protected List properties;

    public List getProperties() {
        if (properties == null) {
            properties = new ArrayList();
        }
        return properties;
    }

    /**
     * The type provides a standardized definition for a schedule.
     */
    @ApiProperty
    protected Type type;

    public Type getType() {
        return type;
    }

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

    /**
     * The associated volume for a schedule.
     */
    @ApiProperty
    protected Storage volume;

    public Storage getVolume() {
        return volume;
    }

    public void setVolume(Storage volume) {
        this.volume = volume;
    }

    /**
     * A flag which determines if a schedule is active.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long active;

    public Long getActive() {
        return active;
    }

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

    protected boolean activeSpecified;

    public boolean isActiveSpecified() {
        return activeSpecified;
    }

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

    /**
     * The date a schedule 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;
    }

    /**
     * A schedule'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 date a schedule was last modified.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar modifyDate;

    public GregorianCalendar getModifyDate() {
        return modifyDate;
    }

    public void setModifyDate(GregorianCalendar modifyDate) {
        modifyDateSpecified = true;
        this.modifyDate = modifyDate;
    }

    protected boolean modifyDateSpecified;

    public boolean isModifyDateSpecified() {
        return modifyDateSpecified;
    }

    public void unsetModifyDate() {
        modifyDate = null;
        modifyDateSpecified = false;
    }

    /**
     * A schedule's name, for example 'Daily'.
     */
    @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;
    }

    /**
     * The partnership id which a schedule is associated with.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long partnershipId;

    public Long getPartnershipId() {
        return partnershipId;
    }

    public void setPartnershipId(Long partnershipId) {
        partnershipIdSpecified = true;
        this.partnershipId = partnershipId;
    }

    protected boolean partnershipIdSpecified;

    public boolean isPartnershipIdSpecified() {
        return partnershipIdSpecified;
    }

    public void unsetPartnershipId() {
        partnershipId = null;
        partnershipIdSpecified = false;
    }

    /**
     * The type id which a schedule is associated with.
     */
    @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;
    }

    /**
     * The volume id which a schedule is associated with.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long volumeId;

    public Long getVolumeId() {
        return volumeId;
    }

    public void setVolumeId(Long volumeId) {
        volumeIdSpecified = true;
        this.volumeId = volumeId;
    }

    protected boolean volumeIdSpecified;

    public boolean isVolumeIdSpecified() {
        return volumeIdSpecified;
    }

    public void unsetVolumeId() {
        volumeId = null;
        volumeIdSpecified = false;
    }

    /**
     * A count of events which have been created as the result of a schedule execution.
     */
    @ApiProperty
    protected Long eventCount;

    public Long getEventCount() {
        return eventCount;
    }

    public void setEventCount(Long eventCount) {
        this.eventCount = eventCount;
    }

    /**
     * A count of properties used for configuration of a schedule.
     */
    @ApiProperty
    protected Long propertyCount;

    public Long getPropertyCount() {
        return propertyCount;
    }

    public void setPropertyCount(Long propertyCount) {
        this.propertyCount = propertyCount;
    }

    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());
    }

    /**
     * Schedules can be created for select Storage services, such as iscsi. These schedules are used to perform various tasks such as scheduling snapshots or synchronizing replicants. 

     * 

     * The schedule service can be used to create, edit, or delete a schedule. Schedules are defined by the properties associated with them to specify values such as the start date, interval, or end date of the schedule. 
     *
     * @see SoftLayer_Network_Storage_Schedule
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Network_Storage_Schedule")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * Delete the property objects from a network storage schedule. '''This cannot be undone.''' 
         *
         * @see SoftLayer_Network_Storage_Schedule::clearProperties
         */
        @ApiMethod(instanceRequired = true)
        public Void clearProperties();

        /**
         * Create a nas volume schedule 
         *
         * @see SoftLayer_Network_Storage_Schedule::createObject
         */
        @ApiMethod
        public Schedule createObject(Schedule templateObject);

        /**
         * Delete a network storage schedule. '''This cannot be undone.''' ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a schedule; 
         *
         * @see SoftLayer_Network_Storage_Schedule::deleteObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean deleteObject();

        /**
         * Edit a nas volume schedule 
         *
         * @see SoftLayer_Network_Storage_Schedule::editObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean editObject(Schedule templateObject);

        /**
         * @see SoftLayer_Network_Storage_Schedule::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Schedule getObject();

        /**
         * Events which have been created as the result of a schedule execution.
         *
         * @see SoftLayer_Network_Storage_Schedule::getEvents
         */
        @ApiMethod(instanceRequired = true)
        public List getEvents();

        /**
         * The associated partnership for a schedule.
         *
         * @see SoftLayer_Network_Storage_Schedule::getPartnership
         */
        @ApiMethod(instanceRequired = true)
        public Partnership getPartnership();

        /**
         * Properties used for configuration of a schedule.
         *
         * @see SoftLayer_Network_Storage_Schedule::getProperties
         */
        @ApiMethod(instanceRequired = true)
        public List getProperties();

        /**
         * The type provides a standardized definition for a schedule.
         *
         * @see SoftLayer_Network_Storage_Schedule::getType
         */
        @ApiMethod(instanceRequired = true)
        public Type getType();

        /**
         * The associated volume for a schedule.
         *
         * @see SoftLayer_Network_Storage_Schedule::getVolume
         */
        @ApiMethod(instanceRequired = true)
        public Storage getVolume();

    }

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

        public Future clearProperties(ResponseHandler callback);

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

        public Future createObject(Schedule templateObject, ResponseHandler callback);

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

        public Future deleteObject(ResponseHandler callback);

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

        public Future editObject(Schedule templateObject, ResponseHandler callback);

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

        public Future getObject(ResponseHandler callback);

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

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

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

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

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

        /**
         * Async callback version of {@link Service#getProperties}
         */
        public Future getProperties(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#getVolume}
         */
        public Future getVolume();

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

    }

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

        public Event.Mask events() {
            return withSubMask("events", Event.Mask.class);
        }

        public Partnership.Mask partnership() {
            return withSubMask("partnership", Partnership.Mask.class);
        }

        public com.softlayer.api.service.network.storage.schedule.Property.Mask properties() {
            return withSubMask("properties", com.softlayer.api.service.network.storage.schedule.Property.Mask.class);
        }

        public com.softlayer.api.service.network.storage.schedule.Type.Mask type() {
            return withSubMask("type", com.softlayer.api.service.network.storage.schedule.Type.Mask.class);
        }

        public com.softlayer.api.service.network.Storage.Mask volume() {
            return withSubMask("volume", com.softlayer.api.service.network.Storage.Mask.class);
        }

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

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

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

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

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

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

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

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

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

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

    }

}