com.softlayer.api.service.user.access.facility.Log 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.user.access.facility;

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 com.softlayer.api.service.Location;
import com.softlayer.api.service.user.access.facility.log.Type;
import java.util.GregorianCalendar;

/**
 * This class represents a login/logout sheet for facility visitors.
 *
 * @see SoftLayer_User_Access_Facility_Log
 */
@ApiType("SoftLayer_User_Access_Facility_Log")
public class Log extends Entity {

    /**
     * This is the account associated with the log entry. For users under a customer's account, it is the customer's account. For contractors and others visiting a colocation area, it is the account associated with the area they visited.
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

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

    /**
     * This is the location of the facility.
     */
    @ApiProperty
    protected Location datacenter;

    public Location getDatacenter() {
        return datacenter;
    }

    public void setDatacenter(Location datacenter) {
        this.datacenter = datacenter;
    }

    /**
     * This is the colocation hardware that was visited.
     */
    @ApiProperty
    protected Hardware hardware;

    public Hardware getHardware() {
        return hardware;
    }

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

    /**
     * This is the type of person entering the facility.
     */
    @ApiProperty
    protected Type logType;

    public Type getLogType() {
        return logType;
    }

    public void setLogType(Type logType) {
        this.logType = logType;
    }

    @ApiProperty
    protected Entity visitor;

    public Entity getVisitor() {
        return visitor;
    }

    public void setVisitor(Entity visitor) {
        this.visitor = visitor;
    }

    /**
     * This is the account associated with a log record. For a customer logging into a datacenter, this is the customer's account. For a contractor or any other guest logging into a customer's cabinet or colocation cage, this is the customer's account. 
     */
    @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;
    }

    /**
     * This is a short description of why the person is at the location. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String description;

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        descriptionSpecified = true;
        this.description = description;
    }

    protected boolean descriptionSpecified;

    public boolean isDescriptionSpecified() {
        return descriptionSpecified;
    }

    public void unsetDescription() {
        description = null;
        descriptionSpecified = false;
    }

    @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;
    }

    @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;
    }

    @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;
    }

    /**
     * This is the date and time the person arrived. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar timeIn;

    public GregorianCalendar getTimeIn() {
        return timeIn;
    }

    public void setTimeIn(GregorianCalendar timeIn) {
        timeInSpecified = true;
        this.timeIn = timeIn;
    }

    protected boolean timeInSpecified;

    public boolean isTimeInSpecified() {
        return timeInSpecified;
    }

    public void unsetTimeIn() {
        timeIn = null;
        timeInSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar timeOut;

    public GregorianCalendar getTimeOut() {
        return timeOut;
    }

    public void setTimeOut(GregorianCalendar timeOut) {
        timeOutSpecified = true;
        this.timeOut = timeOut;
    }

    protected boolean timeOutSpecified;

    public boolean isTimeOutSpecified() {
        return timeOutSpecified;
    }

    public void unsetTimeOut() {
        timeOut = null;
        timeOutSpecified = false;
    }

    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.Location.Mask datacenter() {
            return withSubMask("datacenter", com.softlayer.api.service.Location.Mask.class);
        }

        public com.softlayer.api.service.Hardware.Mask hardware() {
            return withSubMask("hardware", com.softlayer.api.service.Hardware.Mask.class);
        }

        public com.softlayer.api.service.user.access.facility.log.Type.Mask logType() {
            return withSubMask("logType", com.softlayer.api.service.user.access.facility.log.Type.Mask.class);
        }

        public com.softlayer.api.service.Entity.Mask visitor() {
            return withSubMask("visitor", com.softlayer.api.service.Entity.Mask.class);
        }

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

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

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

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

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

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

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

    }

}