Package com.softlayer.api.service.product.upgrade

Interface Request.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Request

@ApiService("SoftLayer_Product_Upgrade_Request")
public static interface Request.Service
extends Service

SoftLayer_Product_Upgrade_Request tracks the progress of an upgrade, and allows modification of the maintenance window and other information.

See Also:

SoftLayer_Product_Upgrade_Request

Method Summary

Modifier and Type	Method	Description
Boolean	approveChanges()	When a change is made to an upgrade by Sales, this method will approve the changes that were made.
Request.ServiceAsync	asAsync()	Get an async version of this service
Account	getAccount()	The account that an order belongs to
Boolean	getCompletedFlag()	Indicates that the upgrade request has completed or has been cancelled.
Invoice	getInvoice()	This is the invoice associated with the upgrade request.
Request	getObject()	getObject retrieves a SoftLayer_Product_Upgrade_Request object on your account whose ID corresponds to the ID of the init parameter passed to the SoftLayer_Product_Upgrade_Request service.
Order	getOrder()	An order record associated to the upgrade request
Hardware	getServer()	A server object associated with the upgrade request if any.
Status	getStatus()	The current status of the upgrade request.
Ticket	getTicket()	The ticket that is used to coordinate the upgrade process.
Customer	getUser()	The user that placed the order.
Guest	getVirtualGuest()	A virtual server object associated with the upgrade request if any.
void	setMask(Request.Mask mask)
Boolean	updateMaintenanceWindow(GregorianCalendar maintenanceStartTime, Long maintenanceWindowId)	In case an upgrade cannot be performed, the maintenance window needs to be updated to a future date.
Request.Mask	withMask()	Use the existing mask on this service or create it if not present
Request.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

Request.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Request.Mask withNewMask()

Description copied from interface: Maskable

Overwrite the existing mask on this service with a new one and return it

Specified by:

withNewMask in interface Maskable

withMask

Request.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(Request.Mask mask)

approveChanges

@ApiMethod(instanceRequired=true)
Boolean approveChanges()

When a change is made to an upgrade by Sales, this method will approve the changes that were made. A customer must acknowledge the change and approve it so that the upgrade request can proceed.

See Also:

SoftLayer_Product_Upgrade_Request::approveChanges

getObject

@ApiMethod(instanceRequired=true)
Request getObject()

getObject retrieves a SoftLayer_Product_Upgrade_Request object on your account whose ID corresponds to the ID of the init parameter passed to the SoftLayer_Product_Upgrade_Request service.

See Also:

SoftLayer_Product_Upgrade_Request::getObject

updateMaintenanceWindow

@ApiMethod(instanceRequired=true)
Boolean updateMaintenanceWindow(GregorianCalendar maintenanceStartTime,
                                Long maintenanceWindowId)

In case an upgrade cannot be performed, the maintenance window needs to be updated to a future date.

See Also:

SoftLayer_Product_Upgrade_Request::updateMaintenanceWindow

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

The account that an order belongs to

See Also:

SoftLayer_Product_Upgrade_Request::getAccount

getCompletedFlag

@ApiMethod(instanceRequired=true)
Boolean getCompletedFlag()

Indicates that the upgrade request has completed or has been cancelled.

See Also:

SoftLayer_Product_Upgrade_Request::getCompletedFlag

getInvoice

@ApiMethod(instanceRequired=true)
Invoice getInvoice()

This is the invoice associated with the upgrade request. For hourly servers or services, an invoice will not be available.

See Also:

SoftLayer_Product_Upgrade_Request::getInvoice

getOrder

@ApiMethod(instanceRequired=true)
Order getOrder()

An order record associated to the upgrade request

See Also:

SoftLayer_Product_Upgrade_Request::getOrder

getServer

@ApiMethod(instanceRequired=true)
Hardware getServer()

A server object associated with the upgrade request if any.

See Also:

SoftLayer_Product_Upgrade_Request::getServer

getStatus

@ApiMethod(instanceRequired=true)
Status getStatus()

The current status of the upgrade request.

See Also:

SoftLayer_Product_Upgrade_Request::getStatus

getTicket

@ApiMethod(instanceRequired=true)
Ticket getTicket()

The ticket that is used to coordinate the upgrade process.

See Also:

SoftLayer_Product_Upgrade_Request::getTicket

getUser

@ApiMethod(instanceRequired=true)
Customer getUser()

The user that placed the order.

See Also:

SoftLayer_Product_Upgrade_Request::getUser

getVirtualGuest

@ApiMethod(instanceRequired=true)
Guest getVirtualGuest()

A virtual server object associated with the upgrade request if any.

See Also:

SoftLayer_Product_Upgrade_Request::getVirtualGuest