public class ComputeImages extends AbstractCoreBulkResources<ComputeImageRestRep> implements TopLevelResources<ComputeImageRestRep>, TaskResources<ComputeImageRestRep>
Base URL: /compute/images
Constructor and Description |
---|
ComputeImages(ViPRCoreClient parent,
RestClient client) |
Modifier and Type | Method and Description |
---|---|
Task<ComputeImageRestRep> |
cloneImage(ComputeImageCreate input)
Begins creating a compute image as a clone.
|
Task<ComputeImageRestRep> |
create(ComputeImageCreate input)
Begins creating a compute image.
|
void |
deactivate(java.net.URI id)
Begins deactivating a compute image by ID.
|
java.util.List<ComputeImageRestRep> |
getAll()
Gets the list of all compute images.
|
java.util.List<ComputeImageRestRep> |
getAll(ResourceFilter<ComputeImageRestRep> filter)
Gets the list of all compute images, optionally filtering the results.
|
Task<ComputeImageRestRep> |
getTask(java.net.URI id,
java.net.URI taskId)
Gets a single task associated with a given resource by ID.
|
Tasks<ComputeImageRestRep> |
getTasks(java.net.URI id)
Gets the tasks associated with a given resource by ID.
|
java.util.List<NamedRelatedResourceRep> |
list()
Lists all compute images.
|
java.util.List<NamedRelatedResourceRep> |
listByImageType(java.lang.String imageType)
Filter to show only ESX/i compute images.
|
Task<ComputeImageRestRep> |
update(java.net.URI id,
ComputeImageUpdate input)
Begins updating a compute image by ID.
|
ComputeImages |
withInactive(boolean inactive)
Configures the fetch operations to include inactive resources.
|
ComputeImages |
withInternal(boolean internal)
Configures the fetch operations to include internal resources.
|
getByIds, getByRefs, listBulkIds
addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, search, updateTags
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getByIds, getByRefs
addTags, get, get, getTags, removeTags, search, updateTags
public ComputeImages(ViPRCoreClient parent, RestClient client)
public ComputeImages withInactive(boolean inactive)
AbstractResources
withInactive
in class AbstractResources<ComputeImageRestRep>
inactive
- whether to include inactive resources.public ComputeImages withInternal(boolean internal)
AbstractResources
withInternal
in class AbstractResources<ComputeImageRestRep>
internal
- whether to include internal resources.public Tasks<ComputeImageRestRep> getTasks(java.net.URI id)
TaskResources
API Call: GET baseUrl/{id}/tasks
getTasks
in interface TaskResources<ComputeImageRestRep>
id
- the resource ID.public Task<ComputeImageRestRep> getTask(java.net.URI id, java.net.URI taskId)
TaskResources
API Call: GET baseUrl/{id}/tasks/{taskId}
getTask
in interface TaskResources<ComputeImageRestRep>
id
- the resource ID.taskId
- the task ID.public java.util.List<NamedRelatedResourceRep> list()
API Call: GET /compute/images
list
in interface TopLevelResources<ComputeImageRestRep>
public java.util.List<ComputeImageRestRep> getAll()
getAll
in interface TopLevelResources<ComputeImageRestRep>
TopLevelResources.list()
,
Resources.getByRefs(java.util.Collection)
public java.util.List<ComputeImageRestRep> getAll(ResourceFilter<ComputeImageRestRep> filter)
getAll
in interface TopLevelResources<ComputeImageRestRep>
filter
- the resource filter to apply to the results as they are returned (optional).TopLevelResources.list()
,
Resources.getByRefs(java.util.Collection, ResourceFilter)
public Task<ComputeImageRestRep> create(ComputeImageCreate input)
API Call: POST /compute/images
input
- the create configuration.public Task<ComputeImageRestRep> update(java.net.URI id, ComputeImageUpdate input)
API Call: PUT /compute/images/{id}
id
- the ID of the compute image to update.input
- the update configuration.public void deactivate(java.net.URI id)
API Call: POST /compute/images/{id}
id
- the ID of the compute image to deactivate.public java.util.List<NamedRelatedResourceRep> listByImageType(java.lang.String imageType)
imageType
- the type of the image (e.g. esx, linux)public Task<ComputeImageRestRep> cloneImage(ComputeImageCreate input)
API Call: POST /compute/images
input
- the clone configuration.