com.softlayer.api.service.account.media.data.transfer.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.media.data.transfer;
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.Ticket;
import com.softlayer.api.service.account.Media;
import com.softlayer.api.service.account.Shipment;
import com.softlayer.api.service.account.media.data.transfer.request.Status;
import com.softlayer.api.service.billing.Item;
import com.softlayer.api.service.user.Customer;
import com.softlayer.api.service.user.Employee;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;
/**
* The SoftLayer_Account_Media_Data_Transfer_Request data type contains information on a single Data Transfer Service request. Creation of these requests is limited to SoftLayer customers through the SoftLayer Customer Portal.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request
*/
@ApiType("SoftLayer_Account_Media_Data_Transfer_Request")
public class Request extends Entity {
/**
* The account to which the request belongs.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
/**
* The active tickets that are attached to the data transfer request.
*/
@ApiProperty
protected List activeTickets;
public List getActiveTickets() {
if (activeTickets == null) {
activeTickets = new ArrayList();
}
return activeTickets;
}
/**
* The billing item for the original request.
*/
@ApiProperty
protected Item billingItem;
public Item getBillingItem() {
return billingItem;
}
public void setBillingItem(Item billingItem) {
this.billingItem = billingItem;
}
/**
* The customer user who created the request.
*/
@ApiProperty
protected Customer createUser;
public Customer getCreateUser() {
return createUser;
}
public void setCreateUser(Customer createUser) {
this.createUser = createUser;
}
/**
* The media of the request.
*/
@ApiProperty
protected Media media;
public Media getMedia() {
return media;
}
public void setMedia(Media media) {
this.media = media;
}
/**
* The employee who last modified the request.
*/
@ApiProperty
protected Employee modifyEmployee;
public Employee getModifyEmployee() {
return modifyEmployee;
}
public void setModifyEmployee(Employee modifyEmployee) {
this.modifyEmployee = modifyEmployee;
}
/**
* The customer user who last modified the request.
*/
@ApiProperty
protected Customer modifyUser;
public Customer getModifyUser() {
return modifyUser;
}
public void setModifyUser(Customer modifyUser) {
this.modifyUser = modifyUser;
}
/**
* The shipments of the request.
*/
@ApiProperty
protected List shipments;
public List getShipments() {
if (shipments == null) {
shipments = new ArrayList();
}
return shipments;
}
/**
* The status of the request.
*/
@ApiProperty
protected Status status;
public Status getStatus() {
return status;
}
public void setStatus(Status status) {
this.status = status;
}
/**
* All tickets that are attached to the data transfer request.
*/
@ApiProperty
protected List tickets;
public List getTickets() {
if (tickets == null) {
tickets = new ArrayList();
}
return tickets;
}
/**
* The account id of the 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;
}
/**
* The create user id of the request.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long createUserId;
public Long getCreateUserId() {
return createUserId;
}
public void setCreateUserId(Long createUserId) {
createUserIdSpecified = true;
this.createUserId = createUserId;
}
protected boolean createUserIdSpecified;
public boolean isCreateUserIdSpecified() {
return createUserIdSpecified;
}
public void unsetCreateUserId() {
createUserId = null;
createUserIdSpecified = false;
}
/**
* The end date of the request.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar endDate;
public GregorianCalendar getEndDate() {
return endDate;
}
public void setEndDate(GregorianCalendar endDate) {
endDateSpecified = true;
this.endDate = endDate;
}
protected boolean endDateSpecified;
public boolean isEndDateSpecified() {
return endDateSpecified;
}
public void unsetEndDate() {
endDate = null;
endDateSpecified = false;
}
/**
* The unique id of the 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;
}
/**
* The modify user id of the request.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long modifyUserId;
public Long getModifyUserId() {
return modifyUserId;
}
public void setModifyUserId(Long modifyUserId) {
modifyUserIdSpecified = true;
this.modifyUserId = modifyUserId;
}
protected boolean modifyUserIdSpecified;
public boolean isModifyUserIdSpecified() {
return modifyUserIdSpecified;
}
public void unsetModifyUserId() {
modifyUserId = null;
modifyUserIdSpecified = false;
}
/**
* The start date of the request.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar startDate;
public GregorianCalendar getStartDate() {
return startDate;
}
public void setStartDate(GregorianCalendar startDate) {
startDateSpecified = true;
this.startDate = startDate;
}
protected boolean startDateSpecified;
public boolean isStartDateSpecified() {
return startDateSpecified;
}
public void unsetStartDate() {
startDate = null;
startDateSpecified = false;
}
/**
* The status id of the request.
*/
@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 active tickets that are attached to the data transfer request.
*/
@ApiProperty
protected Long activeTicketCount;
public Long getActiveTicketCount() {
return activeTicketCount;
}
public void setActiveTicketCount(Long activeTicketCount) {
this.activeTicketCount = activeTicketCount;
}
/**
* A count of the shipments of the request.
*/
@ApiProperty
protected Long shipmentCount;
public Long getShipmentCount() {
return shipmentCount;
}
public void setShipmentCount(Long shipmentCount) {
this.shipmentCount = shipmentCount;
}
/**
* A count of all tickets that are attached to the data transfer request.
*/
@ApiProperty
protected Long ticketCount;
public Long getTicketCount() {
return ticketCount;
}
public void setTicketCount(Long ticketCount) {
this.ticketCount = ticketCount;
}
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());
}
/**
* SoftLayer's Data Transfer Request Service allows users to send SoftLayer media devices such as DVDs, CDs, USB hard drives or USB flash/thumb drives. These media can be connected to SoftLayer servers and presented as ISCSI targets for use by the user. Currently, the initial usage period is two weeks and there is no charge for this service. Additional time for maintaining the media for continued may be purchased. Please contact sales for additional information regarding this. Once the usage period has elapsed. SoftLayer will disconnect the media and return it to the user.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Account_Media_Data_Transfer_Request")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Edit the properties of a data transfer request record by passing in a modified instance of a SoftLayer_Account_Media_Data_Transfer_Request object.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::editObject
*/
@ApiMethod(instanceRequired = true)
public Boolean editObject(Request templateObject);
/**
* Retrieves a list of all the possible statuses to which a request may be set.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::getAllRequestStatuses
*/
@ApiMethod
public List getAllRequestStatuses();
/**
* @see SoftLayer_Account_Media_Data_Transfer_Request::getObject
*/
@ApiMethod(instanceRequired = true)
public Request getObject();
/**
* The account to which the request belongs.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
/**
* The active tickets that are attached to the data transfer request.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::getActiveTickets
*/
@ApiMethod(instanceRequired = true)
public List getActiveTickets();
/**
* The billing item for the original request.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::getBillingItem
*/
@ApiMethod(instanceRequired = true)
public Item getBillingItem();
/**
* The customer user who created the request.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::getCreateUser
*/
@ApiMethod(instanceRequired = true)
public Customer getCreateUser();
/**
* The media of the request.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::getMedia
*/
@ApiMethod(instanceRequired = true)
public Media getMedia();
/**
* The employee who last modified the request.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::getModifyEmployee
*/
@ApiMethod(instanceRequired = true)
public Employee getModifyEmployee();
/**
* The customer user who last modified the request.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::getModifyUser
*/
@ApiMethod(instanceRequired = true)
public Customer getModifyUser();
/**
* The shipments of the request.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::getShipments
*/
@ApiMethod(instanceRequired = true)
public List getShipments();
/**
* The status of the request.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::getStatus
*/
@ApiMethod(instanceRequired = true)
public Status getStatus();
/**
* All tickets that are attached to the data transfer request.
*
* @see SoftLayer_Account_Media_Data_Transfer_Request::getTickets
*/
@ApiMethod(instanceRequired = true)
public List getTickets();
}
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#editObject}
*/
public Future editObject(Request templateObject);
public Future editObject(Request templateObject, ResponseHandler callback);
/**
* Async version of {@link Service#getAllRequestStatuses}
*/
public Future> getAllRequestStatuses();
public Future getAllRequestStatuses(ResponseHandler> callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(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#getActiveTickets}
*/
public Future> getActiveTickets();
/**
* Async callback version of {@link Service#getActiveTickets}
*/
public Future getActiveTickets(ResponseHandler> callback);
/**
* Async version of {@link Service#getBillingItem}
*/
public Future- getBillingItem();
/**
* Async callback version of {@link Service#getBillingItem}
*/
public Future getBillingItem(ResponseHandler
- callback);
/**
* Async version of {@link Service#getCreateUser}
*/
public Future
getCreateUser();
/**
* Async callback version of {@link Service#getCreateUser}
*/
public Future getCreateUser(ResponseHandler callback);
/**
* Async version of {@link Service#getMedia}
*/
public Future getMedia();
/**
* Async callback version of {@link Service#getMedia}
*/
public Future getMedia(ResponseHandler callback);
/**
* Async version of {@link Service#getModifyEmployee}
*/
public Future getModifyEmployee();
/**
* Async callback version of {@link Service#getModifyEmployee}
*/
public Future getModifyEmployee(ResponseHandler callback);
/**
* Async version of {@link Service#getModifyUser}
*/
public Future getModifyUser();
/**
* Async callback version of {@link Service#getModifyUser}
*/
public Future getModifyUser(ResponseHandler callback);
/**
* Async version of {@link Service#getShipments}
*/
public Future> getShipments();
/**
* Async callback version of {@link Service#getShipments}
*/
public Future getShipments(ResponseHandler> callback);
/**
* Async version of {@link Service#getStatus}
*/
public Future getStatus();
/**
* Async callback version of {@link Service#getStatus}
*/
public Future getStatus(ResponseHandler callback);
/**
* Async version of {@link Service#getTickets}
*/
public Future> getTickets();
/**
* Async callback version of {@link Service#getTickets}
*/
public Future getTickets(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 com.softlayer.api.service.Ticket.Mask activeTickets() {
return withSubMask("activeTickets", com.softlayer.api.service.Ticket.Mask.class);
}
public com.softlayer.api.service.billing.Item.Mask billingItem() {
return withSubMask("billingItem", com.softlayer.api.service.billing.Item.Mask.class);
}
public com.softlayer.api.service.user.Customer.Mask createUser() {
return withSubMask("createUser", com.softlayer.api.service.user.Customer.Mask.class);
}
public com.softlayer.api.service.account.Media.Mask media() {
return withSubMask("media", com.softlayer.api.service.account.Media.Mask.class);
}
public com.softlayer.api.service.user.Employee.Mask modifyEmployee() {
return withSubMask("modifyEmployee", com.softlayer.api.service.user.Employee.Mask.class);
}
public com.softlayer.api.service.user.Customer.Mask modifyUser() {
return withSubMask("modifyUser", com.softlayer.api.service.user.Customer.Mask.class);
}
public com.softlayer.api.service.account.Shipment.Mask shipments() {
return withSubMask("shipments", com.softlayer.api.service.account.Shipment.Mask.class);
}
public com.softlayer.api.service.account.media.data.transfer.request.Status.Mask status() {
return withSubMask("status", com.softlayer.api.service.account.media.data.transfer.request.Status.Mask.class);
}
public com.softlayer.api.service.Ticket.Mask tickets() {
return withSubMask("tickets", com.softlayer.api.service.Ticket.Mask.class);
}
public Mask accountId() {
withLocalProperty("accountId");
return this;
}
public Mask createUserId() {
withLocalProperty("createUserId");
return this;
}
public Mask endDate() {
withLocalProperty("endDate");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask modifyUserId() {
withLocalProperty("modifyUserId");
return this;
}
public Mask startDate() {
withLocalProperty("startDate");
return this;
}
public Mask statusId() {
withLocalProperty("statusId");
return this;
}
public Mask activeTicketCount() {
withLocalProperty("activeTicketCount");
return this;
}
public Mask shipmentCount() {
withLocalProperty("shipmentCount");
return this;
}
public Mask ticketCount() {
withLocalProperty("ticketCount");
return this;
}
}
}