com.hpe.i3s.client.deployment

Interface GoldenImageClient

All Superinterfaces:

DeletableResource, RetrievableResource<GoldenImage>, SearchableResource<GoldenImage>

public interface GoldenImageClient
extends SearchableResource<GoldenImage>, DeletableResource

Nested Class Summary

Nested classes/interfaces inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

SearchableResource.GetByNameRequestInterceptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	GOLDEN_IMAGE_ARCHIVED_URI
static String	GOLDEN_IMAGE_DOWNLOAD_URI
static String	GOLDEN_IMAGE_URI

Method Summary

Modifier and Type	Method and Description
String	create(GoldenImage resource) Creates a resource according to the provided resource object.
String	create(GoldenImageFile goldenImage) Creates a golden image resource from the file that is uploaded from a local drive.
String	download(String resourceId, RequestOption... options) Downloads the content of the specified golden image.
String	getArchivedLogs(String resourceId, RequestOption... options) Download the details of the golden image capture logs which has been archived based on the specific resourceId.
GoldenImage	update(String resourceId, GoldenImage resource) Updates the resource identified by resourceId according to the provided resource object.

Methods inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

getByName

Methods inherited from interface com.hp.ov.sdk.rest.client.common.RetrievableResource

get, get, getAll, getAll, getById

Methods inherited from interface com.hp.ov.sdk.rest.client.common.DeletableResource

delete

Field Detail

GOLDEN_IMAGE_URI

static final String GOLDEN_IMAGE_URI

See Also:

Constant Field Values

GOLDEN_IMAGE_DOWNLOAD_URI

static final String GOLDEN_IMAGE_DOWNLOAD_URI

See Also:

Constant Field Values

GOLDEN_IMAGE_ARCHIVED_URI

static final String GOLDEN_IMAGE_ARCHIVED_URI

See Also:

Constant Field Values

Method Detail

create

String create(GoldenImage resource)

Creates a resource according to the provided resource object.

Parameters:

resource - object containing the details of the resource that should be created.

Returns:

String object containing the result of this request.

create

String create(GoldenImageFile goldenImage)

Creates a golden image resource from the file that is uploaded from a local drive.

Only the .zip format file can be used for upload.

Parameters:

goldenImage - object containing the details of the golden image that should be created. Details include the file (.zip format, name and description that should be used to identify the golden image).

Returns:

String containing the result of this request.

getArchivedLogs

String getArchivedLogs(String resourceId,
                       RequestOption... options)

Download the details of the golden image capture logs which has been archived based on the specific resourceId.

Parameters:

resourceId - golden image identifier.

options - varargs of RequestOption which can be used to specify some request options.

Returns:

String containing the result of this request.

download

String download(String resourceId,
                RequestOption... options)

Downloads the content of the specified golden image.

Parameters:

resourceId - golden image identifier.

options - varargs of RequestOption which can be used to specify some request options.

Returns:

String representing the path to the downloaded golden image.

update

GoldenImage update(String resourceId,
                   GoldenImage resource)

Updates the resource identified by resourceId according to the provided resource object.

Parameters:

resourceId - golden image identifier.

resource - object containing the details of the resource that should be updated.

Returns:

GoldenImage object containing the result of this request.