Package com.softlayer.api.service.user.customer

Interface ApiAuthentication.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

ApiAuthentication

@ApiService("SoftLayer_User_Customer_ApiAuthentication")
public static interface ApiAuthentication.Service
extends Service

An account's user may obtain access to SoftLayer's API through this authentication service.

See Also:

SoftLayer_User_Customer_ApiAuthentication

Method Summary

Modifier and Type	Method	Description
ApiAuthentication.ServiceAsync	asAsync()	Get an async version of this service
ApiAuthentication	editObject(ApiAuthentication templateObject)
ApiAuthentication	getObject()	getObject retrieves the SoftLayer_User_Customer_ApiAuthentication object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_ApiAuthentication service.
Customer	getUser()	The user who owns the api authentication key.
void	setMask(ApiAuthentication.Mask mask)
ApiAuthentication.Mask	withMask()	Use the existing mask on this service or create it if not present
ApiAuthentication.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

ApiAuthentication.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

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

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

editObject

@ApiMethod(instanceRequired=true)
ApiAuthentication editObject(ApiAuthentication templateObject)

See Also:

SoftLayer_User_Customer_ApiAuthentication::editObject

getObject

@ApiMethod(instanceRequired=true)
ApiAuthentication getObject()

getObject retrieves the SoftLayer_User_Customer_ApiAuthentication object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_ApiAuthentication service.

See Also:

SoftLayer_User_Customer_ApiAuthentication::getObject

getUser

@ApiMethod(instanceRequired=true)
Customer getUser()

The user who owns the api authentication key.

See Also:

SoftLayer_User_Customer_ApiAuthentication::getUser