com.softlayer.api.service.virtual.guest.block.device.template.Group

@ApiType("SoftLayer_Virtual_Guest_Block_Device_Template_Group")
public class Group
extends Entity

The virtual block device template group data type presents the structure in which a group of archived image templates will be presented. The structure consists of a parent template group which contain multiple child template group objects. Each child template group object represents the image template in a particular location. Unless editing/deleting a specific child template group object, it is best to use the parent object.

A virtual block device template group, also known as an image template group, represents an image of a virtual guest instance.

See Also:: SoftLayer_Virtual_Guest_Block_Device_Template_Group

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Group.Mask`
`static interface`	`Group.Service`	The virtual guest block device template group service provides a common interface to an accounts archived image templates The interaction with various third party APIs is not needed when implementing this service to administer your guests.
`static interface`	`Group.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Account`	`account`	A block device template group's [[SoftLayer_Account\|account]].
`protected Long`	`accountContactCount`	A count of
`protected List<Contact>`	`accountContacts`
`protected Long`	`accountId`	A block device template group's [[SoftLayer_Account\|account]] ID
`protected boolean`	`accountIdSpecified`
`protected Long`	`accountReferenceCount`	A count of the accounts which may have read-only access to an image template group.
`protected List<Accounts>`	`accountReferences`	The accounts which may have read-only access to an image template group.
`protected Long`	`blockDeviceCount`	A count of the block devices that are part of an image template group
`protected List<Template>`	`blockDevices`	The block devices that are part of an image template group
`protected BigDecimal`	`blockDevicesDiskSpaceTotal`	The total disk space of all images in a image template group.
`protected Boolean`	`byolFlag`	A flag indicating that customer is providing the software licenses.
`protected List<Group>`	`children`	The image template groups that are clones of an image template group.
`protected Long`	`childrenCount`	A count of the image template groups that are clones of an image template group.
`protected GregorianCalendar`	`createDate`	The date a block device template group was created.
`protected boolean`	`createDateSpecified`
`protected Location`	`datacenter`	The location containing this image template group.
`protected Long`	`datacenterCount`	A count of a collection of locations containing a copy of this image template group.
`protected List<Location>`	`datacenters`	A collection of locations containing a copy of this image template group.
`protected Group`	`firstChild`	The first clone of the image template group
`protected Boolean`	`flexImageFlag`	A flag indicating if this is a flex image.
`protected String`	`globalIdentifier`	An image template's universally unique identifier.
`protected Long`	`id`	A block device template group's unique ID.
`protected boolean`	`idSpecified`
`protected Type`	`imageType`	The virtual disk image type of this template.
`protected String`	`imageTypeKeyName`	The virtual disk image type keyname (e.g.
`protected String`	`name`	A user definable and optional name of a block device template group.
`protected boolean`	`nameSpecified`
`protected Boolean`	`nextGenFlag`	A flag indicating if this is a next generation image.
`protected String`	`note`	A block device template group's user defined note.
`protected boolean`	`noteSpecified`
`protected Group`	`parent`	The image template group that another image template group was cloned from.
`protected Long`	`parentId`	A block device template group's [[SoftLayer_Virtual_Guest_Block_Device_Template_Group\|parent]] ID.
`protected boolean`	`parentIdSpecified`
`protected Long`	`publicFlag`
`protected boolean`	`publicFlagSpecified`
`protected Resource`	`region`
`protected Long`	`regionCount`	A count of
`protected List<Resource>`	`regions`
`protected Long`	`sshKeyCount`	A count of the ssh keys to be implemented on the server when provisioned or reloaded from an image template group.
`protected List<Key>`	`sshKeys`	The ssh keys to be implemented on the server when provisioned or reloaded from an image template group.
`protected Status`	`status`	A template group's status.
`protected Long`	`statusId`	A block device template group's [[SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status\|status]] ID
`protected boolean`	`statusIdSpecified`
`protected Repository`	`storageRepository`	The storage repository that an image template group resides on.
`protected String`	`summary`	A block device template group's user defined summary.
`protected boolean`	`summarySpecified`
`protected Long`	`tagReferenceCount`	A count of the tags associated with this image template group.
`protected List<Reference>`	`tagReferences`	The tags associated with this image template group.
`protected Transaction`	`transaction`	A transaction that is being performed on a image template group.
`protected Long`	`transactionId`	A block device template group's [[SoftLayer_Provisioning_Version1_Transaction\|transaction]] ID.
`protected boolean`	`transactionIdSpecified`
`protected Long`	`userRecordId`	A block device template group's [[SoftLayer_User_Customer]] ID
`protected boolean`	`userRecordIdSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

Group()

Method Summary

Modifier and Type	Method	Description
`Group.Service`	`asService(ApiClient client)`
`Account`	`getAccount()`
`Long`	`getAccountContactCount()`
`List<Contact>`	`getAccountContacts()`
`Long`	`getAccountId()`
`Long`	`getAccountReferenceCount()`
`List<Accounts>`	`getAccountReferences()`
`Long`	`getBlockDeviceCount()`
`List<Template>`	`getBlockDevices()`
`BigDecimal`	`getBlockDevicesDiskSpaceTotal()`
`Boolean`	`getByolFlag()`
`List<Group>`	`getChildren()`
`Long`	`getChildrenCount()`
`GregorianCalendar`	`getCreateDate()`
`Location`	`getDatacenter()`
`Long`	`getDatacenterCount()`
`List<Location>`	`getDatacenters()`
`Group`	`getFirstChild()`
`Boolean`	`getFlexImageFlag()`
`String`	`getGlobalIdentifier()`
`Long`	`getId()`
`Type`	`getImageType()`
`String`	`getImageTypeKeyName()`
`String`	`getName()`
`Boolean`	`getNextGenFlag()`
`String`	`getNote()`
`Group`	`getParent()`
`Long`	`getParentId()`
`Long`	`getPublicFlag()`
`Resource`	`getRegion()`
`Long`	`getRegionCount()`
`List<Resource>`	`getRegions()`
`Long`	`getSshKeyCount()`
`List<Key>`	`getSshKeys()`
`Status`	`getStatus()`
`Long`	`getStatusId()`
`Repository`	`getStorageRepository()`
`String`	`getSummary()`
`Long`	`getTagReferenceCount()`
`List<Reference>`	`getTagReferences()`
`Transaction`	`getTransaction()`
`Long`	`getTransactionId()`
`Long`	`getUserRecordId()`
`boolean`	`isAccountIdSpecified()`
`boolean`	`isCreateDateSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isNoteSpecified()`
`boolean`	`isParentIdSpecified()`
`boolean`	`isPublicFlagSpecified()`
`boolean`	`isStatusIdSpecified()`
`boolean`	`isSummarySpecified()`
`boolean`	`isTransactionIdSpecified()`
`boolean`	`isUserRecordIdSpecified()`
`static Group.Service`	`service(ApiClient client)`
`static Group.Service`	`service(ApiClient client, Long id)`
`static Group.Service`	`service(ApiClient client, String globalIdentifier)`
`void`	`setAccount(Account account)`
`void`	`setAccountContactCount(Long accountContactCount)`
`void`	`setAccountId(Long accountId)`
`void`	`setAccountReferenceCount(Long accountReferenceCount)`
`void`	`setBlockDeviceCount(Long blockDeviceCount)`
`void`	`setBlockDevicesDiskSpaceTotal(BigDecimal blockDevicesDiskSpaceTotal)`
`void`	`setByolFlag(Boolean byolFlag)`
`void`	`setChildrenCount(Long childrenCount)`
`void`	`setCreateDate(GregorianCalendar createDate)`
`void`	`setDatacenter(Location datacenter)`
`void`	`setDatacenterCount(Long datacenterCount)`
`void`	`setFirstChild(Group firstChild)`
`void`	`setFlexImageFlag(Boolean flexImageFlag)`
`void`	`setGlobalIdentifier(String globalIdentifier)`
`void`	`setId(Long id)`
`void`	`setImageType(Type imageType)`
`void`	`setImageTypeKeyName(String imageTypeKeyName)`
`void`	`setName(String name)`
`void`	`setNextGenFlag(Boolean nextGenFlag)`
`void`	`setNote(String note)`
`void`	`setParent(Group parent)`
`void`	`setParentId(Long parentId)`
`void`	`setPublicFlag(Long publicFlag)`
`void`	`setRegion(Resource region)`
`void`	`setRegionCount(Long regionCount)`
`void`	`setSshKeyCount(Long sshKeyCount)`
`void`	`setStatus(Status status)`
`void`	`setStatusId(Long statusId)`
`void`	`setStorageRepository(Repository storageRepository)`
`void`	`setSummary(String summary)`
`void`	`setTagReferenceCount(Long tagReferenceCount)`
`void`	`setTransaction(Transaction transaction)`
`void`	`setTransactionId(Long transactionId)`
`void`	`setUserRecordId(Long userRecordId)`
`void`	`unsetAccountId()`
`void`	`unsetCreateDate()`
`void`	`unsetId()`
`void`	`unsetName()`
`void`	`unsetNote()`
`void`	`unsetParentId()`
`void`	`unsetPublicFlag()`
`void`	`unsetStatusId()`
`void`	`unsetSummary()`
`void`	`unsetTransactionId()`
`void`	`unsetUserRecordId()`

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- account
  
  @ApiProperty protected Account account
  
  A block device template group's [[SoftLayer_Account|account]].
- accountContacts
  
  @ApiProperty protected List<Contact> accountContacts
- accountReferences
  
  @ApiProperty protected List<Accounts> accountReferences
  
  The accounts which may have read-only access to an image template group. Will only be populated for parent template group objects.
- blockDevices
  
  @ApiProperty protected List<Template> blockDevices
  
  The block devices that are part of an image template group
- blockDevicesDiskSpaceTotal
  
  @ApiProperty protected BigDecimal blockDevicesDiskSpaceTotal
  
  The total disk space of all images in a image template group.
- byolFlag
  
  @ApiProperty protected Boolean byolFlag
  
  A flag indicating that customer is providing the software licenses.
- children
  
  @ApiProperty protected List<Group> children
  
  The image template groups that are clones of an image template group.
- datacenter
  
  @ApiProperty protected Location datacenter
  
  The location containing this image template group. Will only be populated for child template group objects.
- datacenters
  
  @ApiProperty protected List<Location> datacenters
  
  A collection of locations containing a copy of this image template group. Will only be populated for parent template group objects.
- firstChild
  
  @ApiProperty protected Group firstChild
  
  The first clone of the image template group
- flexImageFlag
  
  @ApiProperty protected Boolean flexImageFlag
  
  A flag indicating if this is a flex image.
- globalIdentifier
  
  @ApiProperty protected String globalIdentifier
  
  An image template's universally unique identifier.
- imageType
  
  @ApiProperty protected Type imageType
  
  The virtual disk image type of this template. Value will be populated on parent and child, but only supports object filtering on the parent.
- imageTypeKeyName
  
  @ApiProperty protected String imageTypeKeyName
  
  The virtual disk image type keyname (e.g. SYSTEM, DISK_CAPTURE, ISO, etc) of this template. Value will be populated on parent and child, but only supports object filtering on the parent.
- nextGenFlag
  
  @ApiProperty protected Boolean nextGenFlag
  
  A flag indicating if this is a next generation image.
- parent
  
  @ApiProperty protected Group parent
  
  The image template group that another image template group was cloned from.
- region
  
  @ApiProperty protected Resource region
- regions
  
  @ApiProperty protected List<Resource> regions
- sshKeys
  
  @ApiProperty protected List<Key> sshKeys
  
  The ssh keys to be implemented on the server when provisioned or reloaded from an image template group.
- status
  
  @ApiProperty protected Status status
  
  A template group's status.
- storageRepository
  
  @ApiProperty protected Repository storageRepository
  
  The storage repository that an image template group resides on.
- tagReferences
  
  @ApiProperty protected List<Reference> tagReferences
  
  The tags associated with this image template group.
- transaction
  
  @ApiProperty protected Transaction transaction
  
  A transaction that is being performed on a image template group.
- accountId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long accountId
  
  A block device template group's [[SoftLayer_Account|account]] ID
- accountIdSpecified
  
  protected boolean accountIdSpecified
- createDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar createDate
  
  The date a block device template group was created.
- createDateSpecified
  
  protected boolean createDateSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  A block device template group's unique ID.
- idSpecified
  
  protected boolean idSpecified
- name
  
  @ApiProperty(canBeNullOrNotSet=true) protected String name
  
  A user definable and optional name of a block device template group.
- nameSpecified
  
  protected boolean nameSpecified
- note
  
  @ApiProperty(canBeNullOrNotSet=true) protected String note
  
  A block device template group's user defined note.
- noteSpecified
  
  protected boolean noteSpecified
- parentId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long parentId
  
  A block device template group's [[SoftLayer_Virtual_Guest_Block_Device_Template_Group|parent]] ID. This will only be set when a template group is created from a previously existing template group
- parentIdSpecified
  
  protected boolean parentIdSpecified
- publicFlag
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long publicFlag
- publicFlagSpecified
  
  protected boolean publicFlagSpecified
- statusId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long statusId
  
  A block device template group's [[SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status|status]] ID
- statusIdSpecified
  
  protected boolean statusIdSpecified
- summary
  
  @ApiProperty(canBeNullOrNotSet=true) protected String summary
  
  A block device template group's user defined summary.
- summarySpecified
  
  protected boolean summarySpecified
- transactionId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long transactionId
  
  A block device template group's [[SoftLayer_Provisioning_Version1_Transaction|transaction]] ID. This will only be set when there is a transaction being performed on the block device template group.
- transactionIdSpecified
  
  protected boolean transactionIdSpecified
- userRecordId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long userRecordId
  
  A block device template group's [[SoftLayer_User_Customer]] ID
- userRecordIdSpecified
  
  protected boolean userRecordIdSpecified
- accountContactCount
  
  @ApiProperty protected Long accountContactCount
  
  A count of
- accountReferenceCount
  
  @ApiProperty protected Long accountReferenceCount
  
  A count of the accounts which may have read-only access to an image template group. Will only be populated for parent template group objects.
- blockDeviceCount
  
  @ApiProperty protected Long blockDeviceCount
  
  A count of the block devices that are part of an image template group
- childrenCount
  
  @ApiProperty protected Long childrenCount
  
  A count of the image template groups that are clones of an image template group.
- datacenterCount
  
  @ApiProperty protected Long datacenterCount
  
  A count of a collection of locations containing a copy of this image template group. Will only be populated for parent template group objects.
- regionCount
  
  @ApiProperty protected Long regionCount
  
  A count of
- sshKeyCount
  
  @ApiProperty protected Long sshKeyCount
  
  A count of the ssh keys to be implemented on the server when provisioned or reloaded from an image template group.
- tagReferenceCount
  
  @ApiProperty protected Long tagReferenceCount
  
  A count of the tags associated with this image template group.
Constructor Details
- Group
  
  public Group()
Method Details
- getAccount
  
  public Account getAccount()
- setAccount
  
  public void setAccount(Account account)
- getAccountContacts
  
  public List<Contact> getAccountContacts()
- getAccountReferences
  
  public List<Accounts> getAccountReferences()
- getBlockDevices
  
  public List<Template> getBlockDevices()
- getBlockDevicesDiskSpaceTotal
  
  public BigDecimal getBlockDevicesDiskSpaceTotal()
- setBlockDevicesDiskSpaceTotal
  
  public void setBlockDevicesDiskSpaceTotal(BigDecimal blockDevicesDiskSpaceTotal)
- getByolFlag
  
  public Boolean getByolFlag()
- setByolFlag
  
  public void setByolFlag(Boolean byolFlag)
- getChildren
  
  public List<Group> getChildren()
- getDatacenter
  
  public Location getDatacenter()
- setDatacenter
  
  public void setDatacenter(Location datacenter)
- getDatacenters
  
  public List<Location> getDatacenters()
- getFirstChild
  
  public Group getFirstChild()
- setFirstChild
  
  public void setFirstChild(Group firstChild)
- getFlexImageFlag
  
  public Boolean getFlexImageFlag()
- setFlexImageFlag
  
  public void setFlexImageFlag(Boolean flexImageFlag)
- getGlobalIdentifier
  
  public String getGlobalIdentifier()
- setGlobalIdentifier
  
  public void setGlobalIdentifier(String globalIdentifier)
- getImageType
  
  public Type getImageType()
- setImageType
  
  public void setImageType(Type imageType)
- getImageTypeKeyName
  
  public String getImageTypeKeyName()
- setImageTypeKeyName
  
  public void setImageTypeKeyName(String imageTypeKeyName)
- getNextGenFlag
  
  public Boolean getNextGenFlag()
- setNextGenFlag
  
  public void setNextGenFlag(Boolean nextGenFlag)
- getParent
  
  public Group getParent()
- setParent
  
  public void setParent(Group parent)
- getRegion
  
  public Resource getRegion()
- setRegion
  
  public void setRegion(Resource region)
- getRegions
  
  public List<Resource> getRegions()
- getSshKeys
  
  public List<Key> getSshKeys()
- getStatus
  
  public Status getStatus()
- setStatus
  
  public void setStatus(Status status)
- getStorageRepository
  
  public Repository getStorageRepository()
- setStorageRepository
  
  public void setStorageRepository(Repository storageRepository)
- getTagReferences
  
  public List<Reference> getTagReferences()
- getTransaction
  
  public Transaction getTransaction()
- setTransaction
  
  public void setTransaction(Transaction transaction)
- getAccountId
  
  public Long getAccountId()
- setAccountId
  
  public void setAccountId(Long accountId)
- isAccountIdSpecified
  
  public boolean isAccountIdSpecified()
- unsetAccountId
  
  public void unsetAccountId()
- getCreateDate
  
  public GregorianCalendar getCreateDate()
- setCreateDate
  
  public void setCreateDate(GregorianCalendar createDate)
- isCreateDateSpecified
  
  public boolean isCreateDateSpecified()
- unsetCreateDate
  
  public void unsetCreateDate()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getName
  
  public String getName()
- setName
  
  public void setName(String name)
- isNameSpecified
  
  public boolean isNameSpecified()
- unsetName
  
  public void unsetName()
- getNote
  
  public String getNote()
- setNote
  
  public void setNote(String note)
- isNoteSpecified
  
  public boolean isNoteSpecified()
- unsetNote
  
  public void unsetNote()
- getParentId
  
  public Long getParentId()
- setParentId
  
  public void setParentId(Long parentId)
- isParentIdSpecified
  
  public boolean isParentIdSpecified()
- unsetParentId
  
  public void unsetParentId()
- getPublicFlag
  
  public Long getPublicFlag()
- setPublicFlag
  
  public void setPublicFlag(Long publicFlag)
- isPublicFlagSpecified
  
  public boolean isPublicFlagSpecified()
- unsetPublicFlag
  
  public void unsetPublicFlag()
- getStatusId
  
  public Long getStatusId()
- setStatusId
  
  public void setStatusId(Long statusId)
- isStatusIdSpecified
  
  public boolean isStatusIdSpecified()
- unsetStatusId
  
  public void unsetStatusId()
- getSummary
  
  public String getSummary()
- setSummary
  
  public void setSummary(String summary)
- isSummarySpecified
  
  public boolean isSummarySpecified()
- unsetSummary
  
  public void unsetSummary()
- getTransactionId
  
  public Long getTransactionId()
- setTransactionId
  
  public void setTransactionId(Long transactionId)
- isTransactionIdSpecified
  
  public boolean isTransactionIdSpecified()
- unsetTransactionId
  
  public void unsetTransactionId()
- getUserRecordId
  
  public Long getUserRecordId()
- setUserRecordId
  
  public void setUserRecordId(Long userRecordId)
- isUserRecordIdSpecified
  
  public boolean isUserRecordIdSpecified()
- unsetUserRecordId
  
  public void unsetUserRecordId()
- getAccountContactCount
  
  public Long getAccountContactCount()
- setAccountContactCount
  
  public void setAccountContactCount(Long accountContactCount)
- getAccountReferenceCount
  
  public Long getAccountReferenceCount()
- setAccountReferenceCount
  
  public void setAccountReferenceCount(Long accountReferenceCount)
- getBlockDeviceCount
  
  public Long getBlockDeviceCount()
- setBlockDeviceCount
  
  public void setBlockDeviceCount(Long blockDeviceCount)
- getChildrenCount
  
  public Long getChildrenCount()
- setChildrenCount
  
  public void setChildrenCount(Long childrenCount)
- getDatacenterCount
  
  public Long getDatacenterCount()
- setDatacenterCount
  
  public void setDatacenterCount(Long datacenterCount)
- getRegionCount
  
  public Long getRegionCount()
- setRegionCount
  
  public void setRegionCount(Long regionCount)
- getSshKeyCount
  
  public Long getSshKeyCount()
- setSshKeyCount
  
  public void setSshKeyCount(Long sshKeyCount)
- getTagReferenceCount
  
  public Long getTagReferenceCount()
- setTagReferenceCount
  
  public void setTagReferenceCount(Long tagReferenceCount)
- asService
  
  public Group.Service asService(ApiClient client)
- service
  
  public static Group.Service service(ApiClient client)
- service
  
  public static Group.Service service(ApiClient client, Long id)
- service
  
  public static Group.Service service(ApiClient client, String globalIdentifier)

Class Group

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details