com.softlayer.api.service.event.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.event;

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.user.Customer;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Event_Log data type contains an event detail occurred upon various SoftLayer resources. 
 *
 * @see SoftLayer_Event_Log
 */
@ApiType("SoftLayer_Event_Log")
public class Log extends Entity {

    @ApiProperty
    protected Customer user;

    public Customer getUser() {
        return user;
    }

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

    /**
     * Account id with which the event is associated 
     */
    @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;
    }

    /**
     * Event creation date in millisecond precision 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar eventCreateDate;

    public GregorianCalendar getEventCreateDate() {
        return eventCreateDate;
    }

    public void setEventCreateDate(GregorianCalendar eventCreateDate) {
        eventCreateDateSpecified = true;
        this.eventCreateDate = eventCreateDate;
    }

    protected boolean eventCreateDateSpecified;

    public boolean isEventCreateDateSpecified() {
        return eventCreateDateSpecified;
    }

    public void unsetEventCreateDate() {
        eventCreateDate = null;
        eventCreateDateSpecified = false;
    }

    /**
     * Event name such as "reboot", "cancel", "update host" and so on. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String eventName;

    public String getEventName() {
        return eventName;
    }

    public void setEventName(String eventName) {
        eventNameSpecified = true;
        this.eventName = eventName;
    }

    protected boolean eventNameSpecified;

    public boolean isEventNameSpecified() {
        return eventNameSpecified;
    }

    public void unsetEventName() {
        eventName = null;
        eventNameSpecified = false;
    }

    /**
     * The remote IP Address that made the request 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String ipAddress;

    public String getIpAddress() {
        return ipAddress;
    }

    public void setIpAddress(String ipAddress) {
        ipAddressSpecified = true;
        this.ipAddress = ipAddress;
    }

    protected boolean ipAddressSpecified;

    public boolean isIpAddressSpecified() {
        return ipAddressSpecified;
    }

    public void unsetIpAddress() {
        ipAddress = null;
        ipAddressSpecified = false;
    }

    /**
     * Label or description of the event object 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String label;

    public String getLabel() {
        return label;
    }

    public void setLabel(String label) {
        labelSpecified = true;
        this.label = label;
    }

    protected boolean labelSpecified;

    public boolean isLabelSpecified() {
        return labelSpecified;
    }

    public void unsetLabel() {
        label = null;
        labelSpecified = false;
    }

    /**
     * Meta data for an event in JSON string 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String metaData;

    public String getMetaData() {
        return metaData;
    }

    public void setMetaData(String metaData) {
        metaDataSpecified = true;
        this.metaData = metaData;
    }

    protected boolean metaDataSpecified;

    public boolean isMetaDataSpecified() {
        return metaDataSpecified;
    }

    public void unsetMetaData() {
        metaData = null;
        metaDataSpecified = false;
    }

    /**
     * Event object id 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long objectId;

    public Long getObjectId() {
        return objectId;
    }

    public void setObjectId(Long objectId) {
        objectIdSpecified = true;
        this.objectId = objectId;
    }

    protected boolean objectIdSpecified;

    public boolean isObjectIdSpecified() {
        return objectIdSpecified;
    }

    public void unsetObjectId() {
        objectId = null;
        objectIdSpecified = false;
    }

    /**
     * Event object name such as "server", "dns" and so on. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String objectName;

    public String getObjectName() {
        return objectName;
    }

    public void setObjectName(String objectName) {
        objectNameSpecified = true;
        this.objectName = objectName;
    }

    protected boolean objectNameSpecified;

    public boolean isObjectNameSpecified() {
        return objectNameSpecified;
    }

    public void unsetObjectName() {
        objectName = null;
        objectNameSpecified = false;
    }

    /**
     * OpenIdConnectUserName of the customer who initiated the event 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String openIdConnectUserName;

    public String getOpenIdConnectUserName() {
        return openIdConnectUserName;
    }

    public void setOpenIdConnectUserName(String openIdConnectUserName) {
        openIdConnectUserNameSpecified = true;
        this.openIdConnectUserName = openIdConnectUserName;
    }

    protected boolean openIdConnectUserNameSpecified;

    public boolean isOpenIdConnectUserNameSpecified() {
        return openIdConnectUserNameSpecified;
    }

    public void unsetOpenIdConnectUserName() {
        openIdConnectUserName = null;
        openIdConnectUserNameSpecified = false;
    }

    /**
     * A resource object that is associated with the event
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Entity resource;

    public Entity getResource() {
        return resource;
    }

    public void setResource(Entity resource) {
        resourceSpecified = true;
        this.resource = resource;
    }

    protected boolean resourceSpecified;

    public boolean isResourceSpecified() {
        return resourceSpecified;
    }

    public void unsetResource() {
        resource = null;
        resourceSpecified = false;
    }

    /**
     * A unique trace id. Multiple event can be grouped by a trace id. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String traceId;

    public String getTraceId() {
        return traceId;
    }

    public void setTraceId(String traceId) {
        traceIdSpecified = true;
        this.traceId = traceId;
    }

    protected boolean traceIdSpecified;

    public boolean isTraceIdSpecified() {
        return traceIdSpecified;
    }

    public void unsetTraceId() {
        traceId = null;
        traceIdSpecified = false;
    }

    /**
     * Id of customer who initiated the event 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long userId;

    public Long getUserId() {
        return userId;
    }

    public void setUserId(Long userId) {
        userIdSpecified = true;
        this.userId = userId;
    }

    protected boolean userIdSpecified;

    public boolean isUserIdSpecified() {
        return userIdSpecified;
    }

    public void unsetUserId() {
        userId = null;
        userIdSpecified = false;
    }

    /**
     * Type of user that triggered the event. User type can be CUSTOMER, EMPLOYEE or SYSTEM. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String userType;

    public String getUserType() {
        return userType;
    }

    public void setUserType(String userType) {
        userTypeSpecified = true;
        this.userType = userType;
    }

    protected boolean userTypeSpecified;

    public boolean isUserTypeSpecified() {
        return userTypeSpecified;
    }

    public void unsetUserType() {
        userType = null;
        userTypeSpecified = false;
    }

    /**
     * Customer username who initiated the event 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String username;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        usernameSpecified = true;
        this.username = username;
    }

    protected boolean usernameSpecified;

    public boolean isUsernameSpecified() {
        return usernameSpecified;
    }

    public void unsetUsername() {
        username = null;
        usernameSpecified = false;
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    /**
     * Event Log service lets you find interesting events related to various SoftLayer products and services such as hardware, virtual server or DNS. 
     *
     * @see SoftLayer_Event_Log
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Event_Log")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * This all indexed event names. 
         *
         * @see SoftLayer_Event_Log::getAllEventNames
         */
        @ApiMethod
        public List getAllEventNames(String objectName);

        /**
         * This all indexed event object names. 
         *
         * @see SoftLayer_Event_Log::getAllEventObjectNames
         */
        @ApiMethod
        public List getAllEventObjectNames();

        /**
         * @see SoftLayer_Event_Log::getAllObjects
         */
        @ApiMethod
        public List getAllObjects();

        /**
         * @see SoftLayer_Event_Log::getAllUserTypes
         */
        @ApiMethod
        public List getAllUserTypes();

        /**
         * @see SoftLayer_Event_Log::getUser
         */
        @ApiMethod(instanceRequired = true)
        public Customer getUser();

    }

    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#getAllEventNames}
         */
        public Future> getAllEventNames(String objectName);

        public Future getAllEventNames(String objectName, ResponseHandler> callback);

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

        public Future getAllEventObjectNames(ResponseHandler> callback);

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

        public Future getAllObjects(ResponseHandler> callback);

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

        public Future getAllUserTypes(ResponseHandler> callback);

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

        /**
         * Async callback version of {@link Service#getUser}
         */
        public Future getUser(ResponseHandler callback);

    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

}