com.softlayer.api.service.network.storage.Event 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.network.storage;

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.Schedule;
import com.softlayer.api.service.network.storage.event.Type;
import java.util.GregorianCalendar;

/**
 * Storage volumes can create various events to keep track of what has occurred to the volume. Events provide an audit trail that can be used to verify that various tasks have occurred, such as snapshots to be created by a schedule or remote replication synchronization. 
 *
 * @see SoftLayer_Network_Storage_Event
 */
@ApiType("SoftLayer_Network_Storage_Event")
public class Event extends Entity {

    /**
     * A schedule that is associated with an event. Not all events will have a schedule.
     */
    @ApiProperty
    protected Schedule schedule;

    public Schedule getSchedule() {
        return schedule;
    }

    public void setSchedule(Schedule schedule) {
        this.schedule = schedule;
    }

    /**
     * A Storage volume's event type. The type provides a standardized definition for an event.
     */
    @ApiProperty
    protected Type type;

    public Type getType() {
        return type;
    }

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

    /**
     * The associated volume for an event.
     */
    @ApiProperty
    protected Storage volume;

    public Storage getVolume() {
        return volume;
    }

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

    /**
     * The date an event 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 message text for an event.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        messageSpecified = true;
        this.message = message;
    }

    protected boolean messageSpecified;

    public boolean isMessageSpecified() {
        return messageSpecified;
    }

    public void unsetMessage() {
        message = null;
        messageSpecified = false;
    }

    /**
     * An identifier for the schedule which is associated with an event.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long scheduleId;

    public Long getScheduleId() {
        return scheduleId;
    }

    public void setScheduleId(Long scheduleId) {
        scheduleIdSpecified = true;
        this.scheduleId = scheduleId;
    }

    protected boolean scheduleIdSpecified;

    public boolean isScheduleIdSpecified() {
        return scheduleIdSpecified;
    }

    public void unsetScheduleId() {
        scheduleId = null;
        scheduleIdSpecified = false;
    }

    /**
     * An identifier for the type of an event.
     */
    @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 an event 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;
    }

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

        public Schedule.Mask schedule() {
            return withSubMask("schedule", Schedule.Mask.class);
        }

        public com.softlayer.api.service.network.storage.event.Type.Mask type() {
            return withSubMask("type", com.softlayer.api.service.network.storage.event.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 createDate() {
            withLocalProperty("createDate");
            return this;
        }

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

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

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

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

    }

}