Package com.softlayer.api.service.account

Interface Address.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Address

@ApiService("SoftLayer_Account_Address")
public static interface Address.Service
extends Service

SoftLayer's address service allows you to access and manage addresses associated with your account.

See Also:

SoftLayer_Account_Address

Method Summary

Modifier and Type	Method	Description
Address.ServiceAsync	asAsync()	Get an async version of this service
Address	createObject(Address templateObject)	Create a new address record.
Boolean	editObject(Address templateObject)	Edit the properties of an address record by passing in a modified instance of a SoftLayer_Account_Address object.
Account	getAccount()	The account to which this address belongs.
List<Address>	getAllDataCenters()	Retrieve a list of SoftLayer datacenter addresses.
Customer	getCreateUser()	The customer user who created this address.
Location	getLocation()	The location of this address.
Employee	getModifyEmployee()	The employee who last modified this address.
Customer	getModifyUser()	The customer user who last modified this address.
List<Address>	getNetworkAddress(String name)	Retrieve a list of SoftLayer datacenter addresses.
Address	getObject()
Type	getType()	An account address' type.
void	setMask(Address.Mask mask)
Address.Mask	withMask()	Use the existing mask on this service or create it if not present
Address.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 Details

asAsync

Address.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Address.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

Address.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(Address.Mask mask)

createObject

@ApiMethod
Address createObject(Address templateObject)

Create a new address record. The ''typeId'', ''accountId'', ''description'', ''address1'', ''city'', ''state'', ''country'', and ''postalCode'' properties in the templateObject parameter are required properties and may not be null or empty. Users will be restricted to creating addresses for their account.

See Also:

SoftLayer_Account_Address::createObject

editObject

@ApiMethod(instanceRequired=true)
Boolean editObject(Address templateObject)

Edit the properties of an address record by passing in a modified instance of a SoftLayer_Account_Address object. Users will be restricted to modifying addresses for their account.

See Also:

SoftLayer_Account_Address::editObject

getAllDataCenters

@ApiMethod
List<Address> getAllDataCenters()

Retrieve a list of SoftLayer datacenter addresses.

See Also:

SoftLayer_Account_Address::getAllDataCenters

getNetworkAddress

@ApiMethod
List<Address> getNetworkAddress(String name)

Retrieve a list of SoftLayer datacenter addresses.

See Also:

SoftLayer_Account_Address::getNetworkAddress

getObject

@ApiMethod(instanceRequired=true)
Address getObject()

See Also:

SoftLayer_Account_Address::getObject

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

The account to which this address belongs.

See Also:

SoftLayer_Account_Address::getAccount

getCreateUser

@ApiMethod(instanceRequired=true)
Customer getCreateUser()

The customer user who created this address.

See Also:

SoftLayer_Account_Address::getCreateUser

getLocation

@ApiMethod(instanceRequired=true)
Location getLocation()

The location of this address.

See Also:

SoftLayer_Account_Address::getLocation

getModifyEmployee

@ApiMethod(instanceRequired=true)
Employee getModifyEmployee()

The employee who last modified this address.

See Also:

SoftLayer_Account_Address::getModifyEmployee

getModifyUser

@ApiMethod(instanceRequired=true)
Customer getModifyUser()

The customer user who last modified this address.

See Also:

SoftLayer_Account_Address::getModifyUser

getType

@ApiMethod(instanceRequired=true)
Type getType()

An account address' type.

See Also:

SoftLayer_Account_Address::getType