Interface Guest.Service
-
- All Superinterfaces:
Maskable
,Member.Service
,ResultLimitable
,Service
- Enclosing class:
- Guest
@ApiService("SoftLayer_Scale_Member_Virtual_Guest") public static interface Guest.Service extends Member.Service
A guest member is a scaled guest on a scale group. It is added either automatically or manually based on group settings. It can be removed here, but is usually best removed using one of the scaling features of the group as a whole.- See Also:
- SoftLayer_Scale_Member_Virtual_Guest
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Guest.ServiceAsync
asAsync()
Get an async version of this serviceBoolean
deleteObjectForGuest()
Delete this group member.Guest
getObjectForGuest()
Guest
getVirtualGuest()
The guest for this member.Long
getVirtualGuestId()
The identifier of the guest for this member.void
setMask(Guest.Mask mask)
Guest.Mask
withMask()
Use the existing mask on this service or create it if not presentGuest.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
Methods inherited from interface com.softlayer.api.service.scale.Member.Service
deleteObject, getObject, getScaleGroup, setMask
-
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
-
-
-
Method Detail
-
asAsync
Guest.ServiceAsync asAsync()
Description copied from interface:Service
Get an async version of this service- Specified by:
asAsync
in interfaceMember.Service
- Specified by:
asAsync
in interfaceService
-
withNewMask
Guest.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 interfaceMaskable
- Specified by:
withNewMask
in interfaceMember.Service
-
withMask
Guest.Mask withMask()
Description copied from interface:Maskable
Use the existing mask on this service or create it if not present- Specified by:
withMask
in interfaceMaskable
- Specified by:
withMask
in interfaceMember.Service
-
setMask
void setMask(Guest.Mask mask)
-
deleteObjectForGuest
@ApiMethod(value="deleteObject", instanceRequired=true) Boolean deleteObjectForGuest()
Delete this group member. Note, this can only be done on an active group when it wont cause the group to go below its minimumMemberCount. This is not the recommended way to delete members. Instead, users should invoke scale(-1) on SoftLayer_Scale_Group so it can choose the best guest member to remove.
-
getObjectForGuest
@ApiMethod(value="getObject", instanceRequired=true) Guest getObjectForGuest()
-
getVirtualGuest
@ApiMethod(instanceRequired=true) Guest getVirtualGuest()
The guest for this member.
-
getVirtualGuestId
@ApiMethod(instanceRequired=true) Long getVirtualGuestId()
The identifier of the guest for this member.
-
-