com.softlayer.api.service.monitoring.Robot 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
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
package com.softlayer.api.service.monitoring;
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.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.monitoring.Agent;
import com.softlayer.api.service.monitoring.agent.configuration.template.Group;
import com.softlayer.api.service.monitoring.robot.Status;
import com.softlayer.api.service.provisioning.version1.Transaction;
import com.softlayer.api.service.software.Component;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Future;
/**
* The SoftLayer_Monitoring_Robot data type contains general information relating to a monitoring robot.
*
* @see SoftLayer_Monitoring_Robot
*/
@ApiType("SoftLayer_Monitoring_Robot")
public class Robot extends Entity {
/**
* The account associated with the corresponding robot.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
/**
* The program (monitoring agent) that gets details of a system or application and reporting of the metric data and triggers alarms for predefined events.
*/
@ApiProperty
protected List monitoringAgents;
public List getMonitoringAgents() {
if (monitoringAgents == null) {
monitoringAgents = new ArrayList();
}
return monitoringAgents;
}
/**
* The current status of the robot.
*/
@ApiProperty
protected Status robotStatus;
public Status getRobotStatus() {
return robotStatus;
}
public void setRobotStatus(Status robotStatus) {
this.robotStatus = robotStatus;
}
/**
* The SoftLayer_Software_Component that corresponds to the robot installation on the server.
*/
@ApiProperty
protected Component softwareComponent;
public Component getSoftwareComponent() {
return softwareComponent;
}
public void setSoftwareComponent(Component softwareComponent) {
this.softwareComponent = softwareComponent;
}
/**
* Internal identifier of a SoftLayer account that this robot belongs to
*/
@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;
}
/**
* Internal identifier of a monitoring robot
*/
@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;
}
/**
* Robot name
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String name;
public String getName() {
return name;
}
public void setName(String name) {
nameSpecified = true;
this.name = name;
}
protected boolean nameSpecified;
public boolean isNameSpecified() {
return nameSpecified;
}
public void unsetName() {
name = null;
nameSpecified = false;
}
/**
* Internal identifier of a monitoring robot status
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long statusId;
public Long getStatusId() {
return statusId;
}
public void setStatusId(Long statusId) {
statusIdSpecified = true;
this.statusId = statusId;
}
protected boolean statusIdSpecified;
public boolean isStatusIdSpecified() {
return statusIdSpecified;
}
public void unsetStatusId() {
statusId = null;
statusIdSpecified = false;
}
/**
* A count of the program (monitoring agent) that gets details of a system or application and reporting of the metric data and triggers alarms for predefined events.
*/
@ApiProperty
protected Long monitoringAgentCount;
public Long getMonitoringAgentCount() {
return monitoringAgentCount;
}
public void setMonitoringAgentCount(Long monitoringAgentCount) {
this.monitoringAgentCount = monitoringAgentCount;
}
public Service asService(ApiClient client) {
return service(client, id);
}
public static Service service(ApiClient client) {
return client.createService(Service.class, null);
}
public static Service service(ApiClient client, Long id) {
return client.createService(Service.class, id == null ? null : id.toString());
}
/**
* A monitoring robot is a set of essential agents that lets SoftLayer monitoring management system to communicate with a server, a Cloud Computing Instance or a Bare Metal Instance.
*
* A monitoring robot must be installed in order for any monitoring agent to report monitoring data to a SoftLayer monitoring hub system.
*
* TCP ports from 48000 to 48020 should be open on your server or cloud instance for advanced monitoring robots and agents.
*
* @see SoftLayer_Monitoring_Robot
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Monitoring_Robot")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Checks if a monitoring robot can communicate with SoftLayer monitoring management system via the private network.
*
* TCP port 48000 - 48002 must be open on your server or your virtual server in order for this test to succeed.
*
* @see SoftLayer_Monitoring_Robot::checkConnection
*/
@ApiMethod(instanceRequired = true)
public Boolean checkConnection();
/**
* @see SoftLayer_Monitoring_Robot::deployMonitoringAgents
*/
@ApiMethod(instanceRequired = true)
public Transaction deployMonitoringAgents(Group configurationTemplateGroup);
/**
* Returns available configuration template groups for this monitoring agent.
*
* @see SoftLayer_Monitoring_Robot::getAvailableConfigurationGroups
*/
@ApiMethod(instanceRequired = true)
public List getAvailableConfigurationGroups();
/**
* @see SoftLayer_Monitoring_Robot::getObject
*/
@ApiMethod(instanceRequired = true)
public Robot getObject();
/**
* If our monitoring management system is not able to connect to your monitoring robot, it sets the robot status to "Limited Connectivity". Robots in this status will not be process by our monitoring management system. You cannot manage monitoring agents either.
*
* Use this method to resets monitoring robot status to "Active" to indicate the connection issue is resolved.
*
* @see SoftLayer_Monitoring_Robot::resetStatus
*/
@ApiMethod(instanceRequired = true)
public Boolean resetStatus();
/**
* The account associated with the corresponding robot.
*
* @see SoftLayer_Monitoring_Robot::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
/**
* The program (monitoring agent) that gets details of a system or application and reporting of the metric data and triggers alarms for predefined events.
*
* @see SoftLayer_Monitoring_Robot::getMonitoringAgents
*/
@ApiMethod(instanceRequired = true)
public List getMonitoringAgents();
/**
* The current status of the robot.
*
* @see SoftLayer_Monitoring_Robot::getRobotStatus
*/
@ApiMethod(instanceRequired = true)
public Status getRobotStatus();
/**
* The SoftLayer_Software_Component that corresponds to the robot installation on the server.
*
* @see SoftLayer_Monitoring_Robot::getSoftwareComponent
*/
@ApiMethod(instanceRequired = true)
public Component getSoftwareComponent();
}
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#checkConnection}
*/
public Future checkConnection();
public Future checkConnection(ResponseHandler callback);
/**
* Async version of {@link Service#deployMonitoringAgents}
*/
public Future deployMonitoringAgents(Group configurationTemplateGroup);
public Future deployMonitoringAgents(Group configurationTemplateGroup, ResponseHandler callback);
/**
* Async version of {@link Service#getAvailableConfigurationGroups}
*/
public Future> getAvailableConfigurationGroups();
public Future getAvailableConfigurationGroups(ResponseHandler> callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(ResponseHandler callback);
/**
* Async version of {@link Service#resetStatus}
*/
public Future resetStatus();
public Future resetStatus(ResponseHandler callback);
/**
* Async version of {@link Service#getAccount}
*/
public Future getAccount();
/**
* Async callback version of {@link Service#getAccount}
*/
public Future getAccount(ResponseHandler callback);
/**
* Async version of {@link Service#getMonitoringAgents}
*/
public Future> getMonitoringAgents();
/**
* Async callback version of {@link Service#getMonitoringAgents}
*/
public Future getMonitoringAgents(ResponseHandler> callback);
/**
* Async version of {@link Service#getRobotStatus}
*/
public Future getRobotStatus();
/**
* Async callback version of {@link Service#getRobotStatus}
*/
public Future getRobotStatus(ResponseHandler callback);
/**
* Async version of {@link Service#getSoftwareComponent}
*/
public Future getSoftwareComponent();
/**
* Async callback version of {@link Service#getSoftwareComponent}
*/
public Future getSoftwareComponent(ResponseHandler callback);
}
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 Agent.Mask monitoringAgents() {
return withSubMask("monitoringAgents", Agent.Mask.class);
}
public com.softlayer.api.service.monitoring.robot.Status.Mask robotStatus() {
return withSubMask("robotStatus", com.softlayer.api.service.monitoring.robot.Status.Mask.class);
}
public com.softlayer.api.service.software.Component.Mask softwareComponent() {
return withSubMask("softwareComponent", com.softlayer.api.service.software.Component.Mask.class);
}
public Mask accountId() {
withLocalProperty("accountId");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask name() {
withLocalProperty("name");
return this;
}
public Mask statusId() {
withLocalProperty("statusId");
return this;
}
public Mask monitoringAgentCount() {
withLocalProperty("monitoringAgentCount");
return this;
}
}
}