com.softlayer.api.service.hardware.component.remotemanagement.command.Request 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.hardware.component.remotemanagement.command;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Hardware;
import com.softlayer.api.service.hardware.component.remotemanagement.Command;
import com.softlayer.api.service.network.Component;
import com.softlayer.api.service.user.Customer;
import java.util.GregorianCalendar;

/**
 * The SoftLayer_Hardware_Component_RemoteManagement_Command_Request contains details for remote management commands issued to a server's remote management card.  Details for remote management commands such as powerOn, powerOff, powerCycle, rebootDefault, rebootSoft, rebootHard can be retrieved.  Details such as the user who issued the command, the id of the remote management card the command was issued, when the command was issued may be retrieved. 
 *
 * @see SoftLayer_Hardware_Component_RemoteManagement_Command_Request
 */
@ApiType("SoftLayer_Hardware_Component_RemoteManagement_Command_Request")
public class Request extends Entity {

    /**
     * The id of the hardware to perform the remote management or powerstrip command on.
     */
    @ApiProperty
    protected Hardware hardware;

    public Hardware getHardware() {
        return hardware;
    }

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

    /**
     * A hardware's network components. Network components are hardware components such as IPMI cards or Ethernet cards.
     */
    @ApiProperty
    protected Component networkComponent;

    public Component getNetworkComponent() {
        return networkComponent;
    }

    public void setNetworkComponent(Component networkComponent) {
        this.networkComponent = networkComponent;
    }

    /**
     * The remote management command issued.
     */
    @ApiProperty
    protected Command remoteManagementCommand;

    public Command getRemoteManagementCommand() {
        return remoteManagementCommand;
    }

    public void setRemoteManagementCommand(Command remoteManagementCommand) {
        this.remoteManagementCommand = remoteManagementCommand;
    }

    /**
     * Information regarding the user who issued the remote management command.
     */
    @ApiProperty
    protected Customer user;

    public Customer getUser() {
        return user;
    }

    public void setUser(Customer user) {
        this.user = user;
    }

    /**
     * The timestamp the remote management command was issued.
     */
    @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 hardware id the command was issued for.
     */
    @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;
    }

    /**
     * The timestamp recorded when the remote management command returned a status of the command issued.
     */
    @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;
    }

    /**
     * Execution status of the remote management command.  True is successful.  False is failure.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean processed;

    public Boolean getProcessed() {
        return processed;
    }

    public void setProcessed(Boolean processed) {
        processedSpecified = true;
        this.processed = processed;
    }

    protected boolean processedSpecified;

    public boolean isProcessedSpecified() {
        return processedSpecified;
    }

    public void unsetProcessed() {
        processed = null;
        processedSpecified = false;
    }

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

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

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

        public com.softlayer.api.service.hardware.component.remotemanagement.Command.Mask remoteManagementCommand() {
            return withSubMask("remoteManagementCommand", com.softlayer.api.service.hardware.component.remotemanagement.Command.Mask.class);
        }

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

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

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

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

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

    }

}