Class ListImageOptions
- java.lang.Object
-
- org.jclouds.http.options.BaseHttpRequestOptions
-
- org.jclouds.openstack.v2_0.options.PaginationOptions
-
- org.jclouds.openstack.glance.v1_0.options.ListImageOptions
-
- All Implemented Interfaces:
HttpRequestOptions
public class ListImageOptions extends PaginationOptions
Usage The recommended way to instantiate a ListImageOptions object is to statically import ListImageOptions.Builder.* and invoke a static creation method for each option as needed:import static org.jclouds.openstack.glance.v1_0.options.ListImageOptions.Builder.* // this will list the first 10 images with the name "name", minimum required disk of 5GB. list = api.list(name("newName"), limit(10), minDisk(5));
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListImageOptions.Builder
-
Field Summary
Fields Modifier and Type Field Description static ListImageOptionsNONE-
Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions
formParameters, headers, pathSuffix, payload, queryParameters
-
-
Constructor Summary
Constructors Constructor Description ListImageOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListImageOptionschangesSince(Date ifModifiedSince)Return only those images having a matching name attributeListImageOptionscontainerFormat(ContainerFormat containerFormat)Return only those images having a matching container formatListImageOptionsdiskFormat(DiskFormat diskFormat)Return only those images having a matching disk formatListImageOptionsisProtected(boolean isProtected)Filter to only protected or unprotected imagesListImageOptionsisPublic(boolean isPublic)Return only public images or only private imagesListImageOptionslimit(int limit)To reduce load on the service, list operations will return a maximum of 1,000 items at a time.ListImageOptionsmarker(String marker)The marker parameter is the ID of the last item in the previous list.ListImageOptionsmaxSize(long size)Return those images that have a size attribute less than or equal to sizeListImageOptionsminDisk(long disk)Return only those images having a matching min disk sizeListImageOptionsminRam(long ram)Return only those images having a matching min ram sizeListImageOptionsminSize(long size)Return those images that have a size attribute greater than or equal to sizeListImageOptionsname(String name)Return only those images having a matching name attributeListImageOptionssortAscending()Ascending sort order (smallest first).ListImageOptionssortBy(ImageField key)Results will be ordered by the specified image attribute.ListImageOptionsstatus(Image.Status status)Return only those images that have the requested status-
Methods inherited from class org.jclouds.openstack.v2_0.options.PaginationOptions
queryParameters
-
Methods inherited from class org.jclouds.http.options.BaseHttpRequestOptions
buildFormParameters, buildPathSuffix, buildQueryParameters, buildRequestHeaders, buildStringPayload, equals, getFirstFormOrNull, getFirstHeaderOrNull, getFirstQueryOrNull, hashCode, replaceHeader, toString
-
-
-
-
Field Detail
-
NONE
public static final ListImageOptions NONE
-
-
Method Detail
-
changesSince
public ListImageOptions changesSince(Date ifModifiedSince)
Return only those images having a matching name attribute- Overrides:
changesSincein classPaginationOptions
-
marker
public ListImageOptions marker(String marker)
Description copied from class:PaginationOptionsThe marker parameter is the ID of the last item in the previous list. Items are sorted by create time in descending order. When a create time is not available they are sorted by ID.- Overrides:
markerin classPaginationOptions
-
limit
public ListImageOptions limit(int limit)
Description copied from class:PaginationOptionsTo reduce load on the service, list operations will return a maximum of 1,000 items at a time. To navigate the collection, the parameters limit and offset can be set in the URI (e.g.?limit=0&offset=0). If an offset is given beyond the end of a list an empty list will be returned. Note that list operations never return itemNotFound (404) faults.- Overrides:
limitin classPaginationOptions
-
name
public ListImageOptions name(String name)
Return only those images having a matching name attribute
-
status
public ListImageOptions status(Image.Status status)
Return only those images that have the requested status
-
containerFormat
public ListImageOptions containerFormat(ContainerFormat containerFormat)
Return only those images having a matching container format
-
diskFormat
public ListImageOptions diskFormat(DiskFormat diskFormat)
Return only those images having a matching disk format
-
minRam
public ListImageOptions minRam(long ram)
Return only those images having a matching min ram size
-
minDisk
public ListImageOptions minDisk(long disk)
Return only those images having a matching min disk size
-
minSize
public ListImageOptions minSize(long size)
Return those images that have a size attribute greater than or equal to size
-
maxSize
public ListImageOptions maxSize(long size)
Return those images that have a size attribute less than or equal to size
-
isPublic
public ListImageOptions isPublic(boolean isPublic)
Return only public images or only private images
-
isProtected
public ListImageOptions isProtected(boolean isProtected)
Filter to only protected or unprotected images
-
sortBy
public ListImageOptions sortBy(ImageField key)
Results will be ordered by the specified image attribute.
-
sortAscending
public ListImageOptions sortAscending()
Ascending sort order (smallest first). NOTE: default behavior is to sort descending (largest first)
-
-