com.softlayer.api.service.provisioning.maintenance.Window 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.provisioning.maintenance;

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.provisioning.maintenance.Classification;
import com.softlayer.api.service.provisioning.maintenance.Ticket;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Provisioning_Maintenance_Window represent a time window that SoftLayer performs a hardware or software maintenance and upgrades. 
 *
 * @see SoftLayer_Provisioning_Maintenance_Window
 */
@ApiType("SoftLayer_Provisioning_Maintenance_Window")
public class Window extends Entity {

    /**
     * The date and time a maintenance window is scheduled to begin.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar beginDate;

    public GregorianCalendar getBeginDate() {
        return beginDate;
    }

    public void setBeginDate(GregorianCalendar beginDate) {
        beginDateSpecified = true;
        this.beginDate = beginDate;
    }

    protected boolean beginDateSpecified;

    public boolean isBeginDateSpecified() {
        return beginDateSpecified;
    }

    public void unsetBeginDate() {
        beginDate = null;
        beginDateSpecified = false;
    }

    /**
     * An ISO-8601 numeric representation of the day of the week that a maintenance window is performed. 1: Monday, 7: Sunday
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long dayOfWeek;

    public Long getDayOfWeek() {
        return dayOfWeek;
    }

    public void setDayOfWeek(Long dayOfWeek) {
        dayOfWeekSpecified = true;
        this.dayOfWeek = dayOfWeek;
    }

    protected boolean dayOfWeekSpecified;

    public boolean isDayOfWeekSpecified() {
        return dayOfWeekSpecified;
    }

    public void unsetDayOfWeek() {
        dayOfWeek = null;
        dayOfWeekSpecified = false;
    }

    /**
     * The date and time a maintenance window is scheduled to end.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar endDate;

    public GregorianCalendar getEndDate() {
        return endDate;
    }

    public void setEndDate(GregorianCalendar endDate) {
        endDateSpecified = true;
        this.endDate = endDate;
    }

    protected boolean endDateSpecified;

    public boolean isEndDateSpecified() {
        return endDateSpecified;
    }

    public void unsetEndDate() {
        endDate = null;
        endDateSpecified = false;
    }

    /**
     * Id of the maintenance window
     */
    @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;
    }

    /**
     * An internal identifier of the location (data center) record that a maintenance window takes place in.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long locationId;

    public Long getLocationId() {
        return locationId;
    }

    public void setLocationId(Long locationId) {
        locationIdSpecified = true;
        this.locationId = locationId;
    }

    protected boolean locationIdSpecified;

    public boolean isLocationIdSpecified() {
        return locationIdSpecified;
    }

    public void unsetLocationId() {
        locationId = null;
        locationIdSpecified = false;
    }

    /**
     * An internal identifier of the datacenter timezone.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long portalTzId;

    public Long getPortalTzId() {
        return portalTzId;
    }

    public void setPortalTzId(Long portalTzId) {
        portalTzIdSpecified = true;
        this.portalTzId = portalTzId;
    }

    protected boolean portalTzIdSpecified;

    public boolean isPortalTzIdSpecified() {
        return portalTzIdSpecified;
    }

    public void unsetPortalTzId() {
        portalTzId = null;
        portalTzIdSpecified = 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());
    }

    /**
     * The SoftLayer_Provisioning_Maintenance_Window service returns available maintenance windows at SoftLayer data centers. 
     *
     * @see SoftLayer_Provisioning_Maintenance_Window
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Provisioning_Maintenance_Window")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * getMaintenceWindowForTicket() returns a boolean 
         *
         * @see SoftLayer_Provisioning_Maintenance_Window::addCustomerUpgradeWindow
         */
        @ApiMethod
        public Boolean addCustomerUpgradeWindow(com.softlayer.api.service.container.provisioning.maintenance.Window customerUpgradeWindow);

        /**
         * getMaintenanceClassifications() returns an object of maintenance classifications 
         *
         * @see SoftLayer_Provisioning_Maintenance_Window::getMaintenanceClassifications
         */
        @ApiMethod
        public List getMaintenanceClassifications();

        /**
         * getMaintenanceStartEndTime() returns a specific maintenance window 
         *
         * @see SoftLayer_Provisioning_Maintenance_Window::getMaintenanceStartEndTime
         */
        @ApiMethod
        public Window getMaintenanceStartEndTime(Long ticketId);

        /**
         * getMaintenceWindowForTicket() returns a specific maintenance window 
         *
         * @see SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindowForTicket
         */
        @ApiMethod
        public List getMaintenanceWindowForTicket(Long maintenanceWindowId);

        /**
         * getMaintenanceWindowTicketsByTicketId() returns a list maintenance window ticket records by ticket id 
         *
         * @see SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindowTicketsByTicketId
         */
        @ApiMethod
        public List getMaintenanceWindowTicketsByTicketId(Long ticketId);

        /**
         * This method returns a list of available maintenance windows 
         *
         * @see SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindows
         */
        @ApiMethod
        public List getMaintenanceWindows(GregorianCalendar beginDate, GregorianCalendar endDate, Long locationId, Long slotsNeeded);

        /**
         * (DEPRECATED) Use [[SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindows|getMaintenanceWindows]] method. 
         *
         * @see SoftLayer_Provisioning_Maintenance_Window::getMaintenceWindows
         */
        @ApiMethod
        public List getMaintenceWindows(GregorianCalendar beginDate, GregorianCalendar endDate, Long locationId, Long slotsNeeded);

        /**
         * getMaintenceWindowForTicket() returns a boolean 
         *
         * @see SoftLayer_Provisioning_Maintenance_Window::updateCustomerUpgradeWindow
         */
        @ApiMethod
        public Boolean updateCustomerUpgradeWindow(GregorianCalendar maintenanceStartTime, Long newMaintenanceWindowId, Long ticketId);

    }

    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#addCustomerUpgradeWindow}
         */
        public Future addCustomerUpgradeWindow(com.softlayer.api.service.container.provisioning.maintenance.Window customerUpgradeWindow);

        public Future addCustomerUpgradeWindow(com.softlayer.api.service.container.provisioning.maintenance.Window customerUpgradeWindow, ResponseHandler callback);

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

        public Future getMaintenanceClassifications(ResponseHandler> callback);

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

        public Future getMaintenanceStartEndTime(Long ticketId, ResponseHandler callback);

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

        public Future getMaintenanceWindowForTicket(Long maintenanceWindowId, ResponseHandler> callback);

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

        public Future getMaintenanceWindowTicketsByTicketId(Long ticketId, ResponseHandler> callback);

        /**
         * Async version of {@link Service#getMaintenanceWindows}
         */
        public Future> getMaintenanceWindows(GregorianCalendar beginDate, GregorianCalendar endDate, Long locationId, Long slotsNeeded);

        public Future getMaintenanceWindows(GregorianCalendar beginDate, GregorianCalendar endDate, Long locationId, Long slotsNeeded, ResponseHandler> callback);

        /**
         * Async version of {@link Service#getMaintenceWindows}
         */
        public Future> getMaintenceWindows(GregorianCalendar beginDate, GregorianCalendar endDate, Long locationId, Long slotsNeeded);

        public Future getMaintenceWindows(GregorianCalendar beginDate, GregorianCalendar endDate, Long locationId, Long slotsNeeded, ResponseHandler> callback);

        /**
         * Async version of {@link Service#updateCustomerUpgradeWindow}
         */
        public Future updateCustomerUpgradeWindow(GregorianCalendar maintenanceStartTime, Long newMaintenanceWindowId, Long ticketId);

        public Future updateCustomerUpgradeWindow(GregorianCalendar maintenanceStartTime, Long newMaintenanceWindowId, Long ticketId, ResponseHandler callback);

    }

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

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

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

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

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

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

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

    }

}