com.hpe.i3s.client.deployment

Interface ArtifactsBundleClient

All Superinterfaces:

CreatableResource<CreateArtifactsBundle>, DeletableResource, RetrievableResource<ArtifactsBundle>, SearchableResource<ArtifactsBundle>

public interface ArtifactsBundleClient
extends SearchableResource<ArtifactsBundle>, CreatableResource<CreateArtifactsBundle>, DeletableResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ArtifactsBundleClient.ExtractBundleRequestInterceptor

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	ARTIFACTS_BUNDLE_ARCHIVE_URI
static String	ARTIFACTS_BUNDLE_BACKUPS_URI
static String	ARTIFACTS_BUNDLE_DOWNLOAD_URI
static String	ARTIFACTS_BUNDLE_STOP_ARTIFACT_CREATE_URI
static String	ARTIFACTS_BUNDLE_URI

Method Summary

Modifier and Type	Method and Description
TaskResource	create(File file, RequestOption... options) Creates an artifact bundle according to the provided file object.
TaskResource	createBackupArchiveBundle(File file, String deploymentGrpUri, RequestOption... options) Uploads a backup bundle from a local drive and extract all the artifacts present in the uploaded file.
TaskResource	createBackupBundle(UserBackupParams userBackupParams, RequestOption... options) Creates a backup bundle with all the artifacts present on the appliance.
String	downloadBackupArchiveBundle(String resourceId, RequestOption... options) Downloads the backup archive bundle identified by the provided resourceId.
String	downloadBundle(String resourceId, RequestOption... options) Downloads the content of the selected artifacts bundle to the admin's local drive.
TaskResource	extractBackupBundle(String resourceId, UserBackupParams userBackupParams, RequestOption... options) Extracts the existing backup bundle on the appliance and creates all the artifacts.
TaskResource	extractBundle(String resourceId, RequestOption... options) Extracts the selected artifact bundle and creates the artifacts on the appliance.
ArtifactsBundle	getBackupBundle(String resourceId) Retrieves the backup bundle identified by the given resourceId.
ResourceCollection<ArtifactsBundle>	getBackupBundles() Retrieves a paginated collection (ResourceCollection) containing the details for the available backup bundles.
String	stopBundleCreation(String resourceId, TaskUri taskUri) Stops the creation of the selected artifact bundle, if the associated task is not in completed state.
ArtifactsBundle	update(String resourceId, ArtifactsBundle 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.CreatableResource

create

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

delete

Field Detail

ARTIFACTS_BUNDLE_URI

static final String ARTIFACTS_BUNDLE_URI

See Also:

Constant Field Values

ARTIFACTS_BUNDLE_BACKUPS_URI

static final String ARTIFACTS_BUNDLE_BACKUPS_URI

See Also:

Constant Field Values

ARTIFACTS_BUNDLE_ARCHIVE_URI

static final String ARTIFACTS_BUNDLE_ARCHIVE_URI

See Also:

Constant Field Values

ARTIFACTS_BUNDLE_DOWNLOAD_URI

static final String ARTIFACTS_BUNDLE_DOWNLOAD_URI

See Also:

Constant Field Values

ARTIFACTS_BUNDLE_STOP_ARTIFACT_CREATE_URI

static final String ARTIFACTS_BUNDLE_STOP_ARTIFACT_CREATE_URI

See Also:

Constant Field Values

Method Detail

create

TaskResource create(File file,
                    RequestOption... options)

Creates an artifact bundle according to the provided file object.

Parameters:

file - File instance containing the artifacts bundle file.

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

Returns:

TaskResource task containing the result of this request.

getBackupBundles

ResourceCollection<ArtifactsBundle> getBackupBundles()

Retrieves a paginated collection (ResourceCollection) containing the details for the available backup bundles.

Returns:

ResourceCollection collection containing the details for the available resources.

createBackupBundle

TaskResource createBackupBundle(UserBackupParams userBackupParams,
                                RequestOption... options)

Creates a backup bundle with all the artifacts present on the appliance.

Parameters:

userBackupParams - attributes of the backup bundle.

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

Returns:

TaskResource task containing the result of this request.

createBackupArchiveBundle

TaskResource createBackupArchiveBundle(File file,
                                       String deploymentGrpUri,
                                       RequestOption... options)

Uploads a backup bundle from a local drive and extract all the artifacts present in the uploaded file.

Parameters:

file - File instance containing the backup artifacts bundle file.

deploymentGrpUri - deployment group uri.

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

Returns:

TaskResource task containing the result of this request.

downloadBackupArchiveBundle

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

Downloads the backup archive bundle identified by the provided resourceId.

Parameters:

resourceId - artifacts bundle identifier.

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

Returns:

String representing the path to the downloaded bundle.

getBackupBundle

ArtifactsBundle getBackupBundle(String resourceId)

Retrieves the backup bundle identified by the given resourceId.

Parameters:

resourceId - artifacts bundle resource identifier.

Returns:

ArtifactsBundle object containing the result of this request.

extractBackupBundle

TaskResource extractBackupBundle(String resourceId,
                                 UserBackupParams userBackupParams,
                                 RequestOption... options)

Extracts the existing backup bundle on the appliance and creates all the artifacts.

Parameters:

resourceId - artifacts bundle resource identifier.

userBackupParams - attributes of the backup.

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

Returns:

TaskResource task containing the result of this request.

downloadBundle

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

Downloads the content of the selected artifacts bundle to the admin's local drive.

Parameters:

resourceId - artifacts bundle resource identifier.

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

Returns:

String representing the path to the downloaded bundle.

extractBundle

TaskResource extractBundle(String resourceId,
                           RequestOption... options)

Extracts the selected artifact bundle and creates the artifacts on the appliance.

Parameters:

resourceId - artifacts bundle resource identifier.

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

Returns:

TaskResource task containing the result of this request.

stopBundleCreation

String stopBundleCreation(String resourceId,
                          TaskUri taskUri)

Stops the creation of the selected artifact bundle, if the associated task is not in completed state.

Parameters:

resourceId - artifacts bundle resource identifier.

taskUri - object containing the URI of the task that should be interrupted.

Returns:

String object containing the result of this request.

update

ArtifactsBundle update(String resourceId,
                       ArtifactsBundle resource)

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

Parameters:

resourceId - artifacts bundle resource identifier.

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

Returns:

ArtifactsBundle object containing the result of this request.