com.emc.vipr.client.core

Class FileSnapshots

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractBulkResources<T>

com.emc.vipr.client.core.AbstractCoreBulkResources<T>

com.emc.vipr.client.core.ProjectResources<FileSnapshotRestRep>

com.emc.vipr.client.core.FileSnapshots

All Implemented Interfaces:

BulkResources<FileSnapshotRestRep>, Resources<FileSnapshotRestRep>, TaskResources<FileSnapshotRestRep>

public class FileSnapshots
extends ProjectResources<FileSnapshotRestRep>
implements TaskResources<FileSnapshotRestRep>

File Snapshots resources.

Base URL: /file/snapshots

Constructor Summary

Constructors

Constructor and Description
FileSnapshots(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<FileSnapshotRestRep>	createForFileSystem(java.net.URI fileSystemId, FileSystemSnapshotParam input) Creates a file snapshot for the given file system by ID.
Task<FileSnapshotRestRep>	deactivate(java.net.URI id) Begins deactivating a file snapshot by ID.
Task<FileSnapshotRestRep>	deleteAllExport(java.net.URI id, java.lang.Boolean allDir)
Task<FileSnapshotRestRep>	deleteExport(java.net.URI id, java.lang.Boolean allDir, java.lang.String subDir) Delete file system export rules API Call: DELETE /file/snapshots/{id}/export
Task<FileSnapshotRestRep>	deleteShareACL(java.net.URI id, java.lang.String shareName) Begins removing a share ACL from the given snapshot by ID.
Task<FileSnapshotRestRep>	export(java.net.URI id, FileSystemExportParam input) Begins exporting a given file snapshot by ID.
java.util.List<FileSnapshotRestRep>	getByFileSystem(java.net.URI fileSystemId) Gets the list of file snapshots for the given file system by ID.
java.util.List<FileSnapshotRestRep>	getByFileSystem(java.net.URI fileSystemId, ResourceFilter<FileSnapshotRestRep> filter) Gets the list of file snapshots for the given file system by ID, optionally filtering the results.
java.util.List<ExportRule>	getExport(java.net.URI id, boolean allDirs, java.lang.String subDir) Gets the list of export rules for the given file system by ID.
java.util.List<FileSystemExportParam>	getExports(java.net.URI id) Gets the exports for the given file snapshot by ID.
java.util.List<ShareACL>	getShareACLs(java.net.URI id, java.lang.String shareName) Gets the share ACLs for the given snapshot by ID.
java.util.List<SmbShareResponse>	getShares(java.net.URI id) Gets the shares for the given file snapshot by ID.
Task<FileSnapshotRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<FileSnapshotRestRep>	getTasks(java.net.URI id) Gets the tasks associated with a given resource by ID.
java.util.List<NamedRelatedResourceRep>	listByFileSystem(java.net.URI fileSystemId) Lists the file snapshots for the given file system by ID.
Task<FileSnapshotRestRep>	removeExport(java.net.URI id, java.lang.String protocol, java.lang.String securityType, java.lang.String permissions, java.lang.String rootUserMapping) Removes a single export from a file snapshot by ID.
Task<FileSnapshotRestRep>	removeShare(java.net.URI id, java.lang.String shareName) Removes a share of the given file snapshot by ID.
Task<FileSnapshotRestRep>	restore(java.net.URI id) Begins restoring a file snapshot by ID.
Task<FileSnapshotRestRep>	share(java.net.URI id, FileSystemShareParam input) Begins sharing a file snapshot by ID.
Task<FileSnapshotRestRep>	updateExport(java.net.URI id, java.lang.String subDirectory, SnapshotExportUpdateParams input) Update file system exports API Call: PUT /file/snapshots/{id}/export
Task<FileSnapshotRestRep>	updateShareACL(java.net.URI id, java.lang.String shareName, SnapshotCifsShareACLUpdateParams param) Update snapshot share ACL API Call: PUT /file/snapshots/{id}/shares/{shareName}/acl
FileSnapshots	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
FileSnapshots	withInternal(boolean internal) Configures the fetch operations to include internal resources.

Methods inherited from class com.emc.vipr.client.core.ProjectResources

findByProject, findByProject, findByProject, findByProject, search

Methods inherited from class com.emc.vipr.client.core.AbstractBulkResources

getByIds, getByRefs, listBulkIds

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, updateTags

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.emc.vipr.client.core.BulkResources

getByIds, getByRefs

Methods inherited from interface com.emc.vipr.client.core.Resources

addTags, get, get, getTags, removeTags, updateTags

Constructor Detail

FileSnapshots

public FileSnapshots(ViPRCoreClient parent,
                     RestClient client)

Method Detail

withInactive

public FileSnapshots withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<FileSnapshotRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public FileSnapshots withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<FileSnapshotRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

public Tasks<FileSnapshotRestRep> getTasks(java.net.URI id)

Description copied from interface: TaskResources

Gets the tasks associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks

Specified by:

getTasks in interface TaskResources<FileSnapshotRestRep>

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

public Task<FileSnapshotRestRep> getTask(java.net.URI id,
                                         java.net.URI taskId)

Description copied from interface: TaskResources

Gets a single task associated with a given resource by ID.

API Call: GET baseUrl/{id}/tasks/{taskId}

Specified by:

getTask in interface TaskResources<FileSnapshotRestRep>

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

restore

public Task<FileSnapshotRestRep> restore(java.net.URI id)

Begins restoring a file snapshot by ID.

API Call: POST /file/snapshots/{id}/restore

Parameters:

id - the ID of the file snapshot to restore.

Returns:

a task for monitoring the progress of the operation.

deactivate

public Task<FileSnapshotRestRep> deactivate(java.net.URI id)

Begins deactivating a file snapshot by ID.

API Call: POST /file/snapshots/{id}/deactivate

Parameters:

id - the ID of the file snapshot to deactivate.

Returns:

a task for monitoring the progress of the operation.

getExports

public java.util.List<FileSystemExportParam> getExports(java.net.URI id)

Gets the exports for the given file snapshot by ID.

API Call: GET /file/snapshots/{id}/exports

Parameters:

id - the ID of the file snapshot.

Returns:

the list of exports for the snapshot.

getExport

public java.util.List<ExportRule> getExport(java.net.URI id,
                                            boolean allDirs,
                                            java.lang.String subDir)

Gets the list of export rules for the given file system by ID.

API Call: GET /file/snapshots/{id}/exports

Parameters:

id - the ID of the snapshot.

allDirs - boolean value for indicating for all directories

subDir - string indicating on what subdirectory to query

Returns:

the list of export rules for the file system.

export

public Task<FileSnapshotRestRep> export(java.net.URI id,
                                        FileSystemExportParam input)

Begins exporting a given file snapshot by ID.

API Call: POST /file/snapshots/{id}/exports

Parameters:

id - the ID of the file snapshot to export.

input - the export configuration.

Returns:

a task for monitoring the progress of the operation.

removeExport

public Task<FileSnapshotRestRep> removeExport(java.net.URI id,
                                              java.lang.String protocol,
                                              java.lang.String securityType,
                                              java.lang.String permissions,
                                              java.lang.String rootUserMapping)

Removes a single export from a file snapshot by ID.

API Call: DELETE /file/snapshots/{id}/exports/{protocol},{securityType},{permissions},{rootUserMapping}

Parameters:

id - the ID of the file snapshot.

protocol - the protocol of the export to remove.

securityType - the security type of the export to remove.

permissions - the permissions of the export to remove.

rootUserMapping - the root user mapping of the export to remove.

Returns:

a task for monitoring the progress of the operation.

getShares

public java.util.List<SmbShareResponse> getShares(java.net.URI id)

Gets the shares for the given file snapshot by ID.

API Call: GET /file/snapshots/{id}/shares

Parameters:

id - the ID of the file snapshot.

Returns:

the list of shares for the file snapshot.

share

public Task<FileSnapshotRestRep> share(java.net.URI id,
                                       FileSystemShareParam input)

Begins sharing a file snapshot by ID.

API Call: POST /file/snapshots/{id}/shares

Parameters:

id - the ID of the file snapshot.

input - the share configuration.

Returns:

a task for monitoring the progress of the operation.

removeShare

public Task<FileSnapshotRestRep> removeShare(java.net.URI id,
                                             java.lang.String shareName)

Removes a share of the given file snapshot by ID.

API Call: DELETE /file/snapshots/{id}/shares/{shareName}

Parameters:

id - the ID of the file snapshot.

shareName - the name of the share to remove.

Returns:

a task for monitoring the progress of the operation.

listByFileSystem

public java.util.List<NamedRelatedResourceRep> listByFileSystem(java.net.URI fileSystemId)

Lists the file snapshots for the given file system by ID.

API Call: GET /file/filesystems/{fileSystemId}/protection/snapshots

Parameters:

fileSystemId - the ID of the file system.

Returns:

the list of file snapshot references for the file system.

getByFileSystem

public java.util.List<FileSnapshotRestRep> getByFileSystem(java.net.URI fileSystemId)

Gets the list of file snapshots for the given file system by ID.

This is a convenience method for: getByRefs(listByFileSystem(fileSystemId))

Parameters:

fileSystemId - the ID of the file system.

Returns:

the list of file snapshots for the file system.

getByFileSystem

public java.util.List<FileSnapshotRestRep> getByFileSystem(java.net.URI fileSystemId,
                                                           ResourceFilter<FileSnapshotRestRep> filter)

Gets the list of file snapshots for the given file system by ID, optionally filtering the results.

This is a convenience method for: getByRefs(listByFileSystem(fileSystemId), filter)

Parameters:

fileSystemId - the ID of the file system.

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the list of file snapshots for the file system.

createForFileSystem

public Task<FileSnapshotRestRep> createForFileSystem(java.net.URI fileSystemId,
                                                     FileSystemSnapshotParam input)

Creates a file snapshot for the given file system by ID.

API Call: POST /block/volumes/{volumeId}/protection/snapshots

Parameters:

fileSystemId - the ID of the file system.

input - the create configuration.

Returns:

tasks for monitoring the progress of the operation(s).

updateExport

public Task<FileSnapshotRestRep> updateExport(java.net.URI id,
                                              java.lang.String subDirectory,
                                              SnapshotExportUpdateParams input)

Update file system exports API Call: PUT /file/snapshots/{id}/export

Parameters:

id - the ID of the snapshot

subDirectory - the subdirectory to be exported

input - the update/create configuration

deleteExport

public Task<FileSnapshotRestRep> deleteExport(java.net.URI id,
                                              java.lang.Boolean allDir,
                                              java.lang.String subDir)

Delete file system export rules API Call: DELETE /file/snapshots/{id}/export

Parameters:

id - the ID of the snapshot

allDir - Boolean to specify all directories

subDir - specific directory to delete export rules

deleteAllExport

public Task<FileSnapshotRestRep> deleteAllExport(java.net.URI id,
                                                 java.lang.Boolean allDir)

getShareACLs

public java.util.List<ShareACL> getShareACLs(java.net.URI id,
                                             java.lang.String shareName)

Gets the share ACLs for the given snapshot by ID.

API Call: GET /file/snapshots/{id}/shares/{shareName}/acl

Parameters:

id - the ID of the snapshot.

shareName - the shareName to get list of ACLS associated.

Returns:

the list of share ACLs for the given file system.

updateShareACL

public Task<FileSnapshotRestRep> updateShareACL(java.net.URI id,
                                                java.lang.String shareName,
                                                SnapshotCifsShareACLUpdateParams param)

Update snapshot share ACL API Call: PUT /file/snapshots/{id}/shares/{shareName}/acl

Parameters:

id - the ID of the snapshot.

shareName - the shareName to update associated ACLs

param - the update/create configuration

Returns:

a task for monitoring the progress of the operation.

deleteShareACL

public Task<FileSnapshotRestRep> deleteShareACL(java.net.URI id,
                                                java.lang.String shareName)

Begins removing a share ACL from the given snapshot by ID.

API Call: Delete /file/snapshots/{id}/shares/{shareName}/acl

Parameters:

id - the ID of the snapshot.

shareName - the name of the share to remove associated ACLs.

Returns:

a task for monitoring the progress of the operation.