com.softlayer.api.service.container.virtual.ConsoleData 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.container.virtual;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;

/**
 * The SoftLayer_Container_Virtual_ConsoleData data type contains information used to access a VSIs console 
 *
 * @see SoftLayer_Container_Virtual_ConsoleData
 */
@ApiType("SoftLayer_Container_Virtual_ConsoleData")
public class ConsoleData extends Entity {

    /**
     * The websocket host address used to access the console
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String websocketHost;

    public String getWebsocketHost() {
        return websocketHost;
    }

    public void setWebsocketHost(String websocketHost) {
        websocketHostSpecified = true;
        this.websocketHost = websocketHost;
    }

    protected boolean websocketHostSpecified;

    public boolean isWebsocketHostSpecified() {
        return websocketHostSpecified;
    }

    public void unsetWebsocketHost() {
        websocketHost = null;
        websocketHostSpecified = false;
    }

    /**
     * The path to the websocket
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String websocketPath;

    public String getWebsocketPath() {
        return websocketPath;
    }

    public void setWebsocketPath(String websocketPath) {
        websocketPathSpecified = true;
        this.websocketPath = websocketPath;
    }

    protected boolean websocketPathSpecified;

    public boolean isWebsocketPathSpecified() {
        return websocketPathSpecified;
    }

    public void unsetWebsocketPath() {
        websocketPath = null;
        websocketPathSpecified = false;
    }

    /**
     * The websocket port used to access the console
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String websocketPort;

    public String getWebsocketPort() {
        return websocketPort;
    }

    public void setWebsocketPort(String websocketPort) {
        websocketPortSpecified = true;
        this.websocketPort = websocketPort;
    }

    protected boolean websocketPortSpecified;

    public boolean isWebsocketPortSpecified() {
        return websocketPortSpecified;
    }

    public void unsetWebsocketPort() {
        websocketPort = null;
        websocketPortSpecified = false;
    }

    /**
     * The token used to authenticate with the console websocket
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String websocketToken;

    public String getWebsocketToken() {
        return websocketToken;
    }

    public void setWebsocketToken(String websocketToken) {
        websocketTokenSpecified = true;
        this.websocketToken = websocketToken;
    }

    protected boolean websocketTokenSpecified;

    public boolean isWebsocketTokenSpecified() {
        return websocketTokenSpecified;
    }

    public void unsetWebsocketToken() {
        websocketToken = null;
        websocketTokenSpecified = false;
    }

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

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

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

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

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

    }

}