C# Class OneAndOne.Client.Endpoints.Images.Images

Inheritance: ResourceBase

Show file Open project: 1and1/oneandone-cloudserver-sdk-dotnet

Public Methods

Method	Description
Create ( CreateImageRequest image ) : ImagesResponse	Adds a new image.
Delete ( string image_id ) : ImagesResponse	Removes an image.
Get ( int page = null, int perPage = null, string sort = null, string query = null, string fields = null ) : List	Returns a list of your images.
Images ( object _apiUrl = null, object _apiKey = null ) : System
Show ( string image_id ) : ImagesResponse	Returns information about one flavour.
Update ( UpdateImageRequest image, string image_id ) : ImagesResponse	Modifies an image.

Method Details

Create() public method

Adds a new image.

public Create ( CreateImageRequest image ) : ImagesResponse
image	OneAndOne.POCO.Requests.Images.CreateImageRequest
return	OneAndOne.POCO.Respones.Images.ImagesResponse

Delete() public method

Removes an image.

public Delete ( string image_id ) : ImagesResponse
image_id	string	required (string ), Unique image's identifier.
return	OneAndOne.POCO.Respones.Images.ImagesResponse

Get() public method

Returns a list of your images.

public Get ( int page = null, int perPage = null, string sort = null, string query = null, string fields = null ) : List
page	int	Allows to use pagination. Sets the number of servers that will be shown in each page.
perPage	int	Current page to show.
sort	string	Allows to sort the result by priority:sort=name retrieves a list of elements ordered by their names.sort=-creation_date retrieves a list of elements ordered according to their creation date in descending order of priority.
query	string	Allows to search one string in the response and return the elements that contain it. In order to specify the string use parameter q: q=My server
fields	string	Returns only the parameters requested: fields=id,name,description,hardware.ram
return	List

Images() public method

public Images ( object _apiUrl = null, object _apiKey = null ) : System
_apiUrl	object
_apiKey	object
return	System

Show() public method

Returns information about one flavour.

public Show ( string image_id ) : ImagesResponse
image_id	string
return	OneAndOne.POCO.Respones.Images.ImagesResponse

Update() public method

Modifies an image.

public Update ( UpdateImageRequest image, string image_id ) : ImagesResponse
image	OneAndOne.POCO.Requests.Images.UpdateImageRequest
image_id	string
return	OneAndOne.POCO.Respones.Images.ImagesResponse