com.softlayer.api.service.account.lockdown.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
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
package com.softlayer.api.service.account.lockdown;
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 java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;
/**
* The SoftLayer_Account_Lockdown_Request data type holds information on API requests from brand customers.
*
* @see SoftLayer_Account_Lockdown_Request
*/
@ApiType("SoftLayer_Account_Lockdown_Request")
public class Request extends Entity {
/**
* Account ID associated with this lockdown request.
*/
@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;
}
/**
* Type of request.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String action;
public String getAction() {
return action;
}
public void setAction(String action) {
actionSpecified = true;
this.action = action;
}
protected boolean actionSpecified;
public boolean isActionSpecified() {
return actionSpecified;
}
public void unsetAction() {
action = null;
actionSpecified = false;
}
/**
* Timestamp when the lockdown request was initially made.
*/
@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;
}
/**
* ID of this lockdown request.
*/
@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;
}
/**
* Timestamp when the lockdown request was modified.
*/
@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;
}
/**
* Status of the lockdown request denoting whether it's been completed.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String status;
public String getStatus() {
return status;
}
public void setStatus(String status) {
statusSpecified = true;
this.status = status;
}
protected boolean statusSpecified;
public boolean isStatusSpecified() {
return statusSpecified;
}
public void unsetStatus() {
status = null;
statusSpecified = false;
}
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());
}
/**
* This service allows approved brands the ability to disconnect, reconnect, and disable customer accounts under that brand. Brand customers are able to make requests on their customers through an API call to this service.
*
* Disconnecting a customer will disable all hardware resources (servers and virtual machines) via a lockdown event. The customer will continue to have control portal access as well as access to their private ports.
*
* Reconnecting a customer will restore all previously disconnected public access. The original lockdown event will be closed.
*
* Disabling an account is a PERMANENT action. All billable items under the account will be canceled, access to the control portal, all resources, network access and hardware will be permanently disabled and reclaimed.
*
* @see SoftLayer_Account_Lockdown_Request
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Account_Lockdown_Request")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Will cancel a lockdown request scheduled in the future. Once canceled, the lockdown request cannot be reconciled and new requests must be made for subsequent actions on the account.
*
* @see SoftLayer_Account_Lockdown_Request::cancelRequest
*/
@ApiMethod(instanceRequired = true)
public Void cancelRequest();
/**
* Takes the original lockdown request ID, and an optional disable date. If no date is passed with the API call, the account will be disabled immediately. Otherwise, the account will be disabled on the date given. All hardware will be reclaimed and all accounts permanently disabled.
*
* @see SoftLayer_Account_Lockdown_Request::disableLockedAccount
*/
@ApiMethod(instanceRequired = true)
public Long disableLockedAccount(String disableDate);
/**
* Takes an account ID and an optional disconnect date. If no disconnect date is passed into the API call, the account disconnection will happen immediately. Otherwise, the account disconnection will happen on the date given. A brand account request ID will be returned and will then be updated when the disconnection occurs.
*
* @see SoftLayer_Account_Lockdown_Request::disconnectCompute
*/
@ApiMethod
public Long disconnectCompute(Long accountId, String disconnectDate);
/**
* Provides a history of an account's lockdown requests and their status.
*
* @see SoftLayer_Account_Lockdown_Request::getAccountHistory
*/
@ApiMethod
public List getAccountHistory(Long accountId);
/**
* @see SoftLayer_Account_Lockdown_Request::getObject
*/
@ApiMethod(instanceRequired = true)
public Request getObject();
/**
* Takes the original disconnected lockdown event ID, and an optional reconnect date. If no reconnect date is passed with the API call, the account reconnection will happen immediately. Otherwise, the account reconnection will happen on the date given. The associated lockdown event will be unlocked and closed at that time.
*
* @see SoftLayer_Account_Lockdown_Request::reconnectCompute
*/
@ApiMethod(instanceRequired = true)
public Long reconnectCompute(String reconnectDate);
}
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#cancelRequest}
*/
public Future cancelRequest();
public Future cancelRequest(ResponseHandler callback);
/**
* Async version of {@link Service#disableLockedAccount}
*/
public Future disableLockedAccount(String disableDate);
public Future disableLockedAccount(String disableDate, ResponseHandler callback);
/**
* Async version of {@link Service#disconnectCompute}
*/
public Future disconnectCompute(Long accountId, String disconnectDate);
public Future disconnectCompute(Long accountId, String disconnectDate, ResponseHandler callback);
/**
* Async version of {@link Service#getAccountHistory}
*/
public Future> getAccountHistory(Long accountId);
public Future getAccountHistory(Long accountId, ResponseHandler> callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(ResponseHandler callback);
/**
* Async version of {@link Service#reconnectCompute}
*/
public Future reconnectCompute(String reconnectDate);
public Future reconnectCompute(String reconnectDate, ResponseHandler callback);
}
public static class Mask extends com.softlayer.api.service.Entity.Mask {
public Mask accountId() {
withLocalProperty("accountId");
return this;
}
public Mask action() {
withLocalProperty("action");
return this;
}
public Mask createDate() {
withLocalProperty("createDate");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask modifyDate() {
withLocalProperty("modifyDate");
return this;
}
public Mask status() {
withLocalProperty("status");
return this;
}
}
}