com.emc.vipr.client.core

Class QuotaDirectories

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<QuotaDirectoryRestRep>

com.emc.vipr.client.core.QuotaDirectories

All Implemented Interfaces:

BulkResources<QuotaDirectoryRestRep>, Resources<QuotaDirectoryRestRep>, TaskResources<QuotaDirectoryRestRep>

public class QuotaDirectories
extends ProjectResources<QuotaDirectoryRestRep>
implements TaskResources<QuotaDirectoryRestRep>

File Systems quota directory resources.

Base URL: /file/quotadirectories

Constructor Summary

Constructors

Constructor and Description
QuotaDirectories(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<QuotaDirectoryRestRep>	createQuotaDirectory(java.net.URI fileSystemId, QuotaDirectoryCreateParam input) Begins creating quota-directory for a file system
Task<QuotaDirectoryRestRep>	deleteQuotaDirectory(java.net.URI id, QuotaDirectoryDeleteParam input) Begins deleting quota-directory from a file system
java.util.List<QuotaDirectoryRestRep>	getByFileSystem(java.net.URI fileSystemId) Gets the list of file quota directories for the given file system by ID.
java.util.List<QuotaDirectoryRestRep>	getByFileSystem(java.net.URI fileSystemId, ResourceFilter<QuotaDirectoryRestRep> filter) Gets the list of file quota directories for the given file system by ID, optionally filtering the results.
QuotaDirectoryRestRep	getQuotaDirectory(java.net.URI id) Gets the quota directory by ID.
Task<QuotaDirectoryRestRep>	getTask(java.net.URI id, java.net.URI taskId) Gets a single task associated with a given resource by ID.
Tasks<QuotaDirectoryRestRep>	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 quota directories for the given file system by ID.
Task<QuotaDirectoryRestRep>	updateQuotaDirectory(java.net.URI id, QuotaDirectoryUpdateParam update) Updates an quota directory from the given quota directory ID.
QuotaDirectories	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
QuotaDirectories	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

QuotaDirectories

public QuotaDirectories(ViPRCoreClient parent,
                        RestClient client)

Method Detail

withInactive

public QuotaDirectories withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<QuotaDirectoryRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public QuotaDirectories withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<QuotaDirectoryRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getTasks

public Tasks<QuotaDirectoryRestRep> 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<QuotaDirectoryRestRep>

Parameters:

id - the resource ID.

Returns:

the tasks for the resource.

getTask

public Task<QuotaDirectoryRestRep> 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<QuotaDirectoryRestRep>

Parameters:

id - the resource ID.

taskId - the task ID.

Returns:

the task.

createQuotaDirectory

public Task<QuotaDirectoryRestRep> createQuotaDirectory(java.net.URI fileSystemId,
                                                        QuotaDirectoryCreateParam input)

Begins creating quota-directory for a file system

API Call: POST /file/filesystems/{id}/quota-directories

Parameters:

fileSystemId - the ID of the file system.

input - the Quota directory configuration.

Returns:

a task for monitoring the progress of the operation.

updateQuotaDirectory

public Task<QuotaDirectoryRestRep> updateQuotaDirectory(java.net.URI id,
                                                        QuotaDirectoryUpdateParam update)

Updates an quota directory from the given quota directory ID.

API Call: POST /file/quotadirectories/{id}

Parameters:

id - the ID of the quota directory.

update - the update configuration.

Returns:

a task for monitoring the progress of the operation.

deleteQuotaDirectory

public Task<QuotaDirectoryRestRep> deleteQuotaDirectory(java.net.URI id,
                                                        QuotaDirectoryDeleteParam input)

Begins deleting quota-directory from a file system

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

Parameters:

id - the ID of the quota directory.

Returns:

a task for monitoring the progress of the operation.

getQuotaDirectory

public QuotaDirectoryRestRep getQuotaDirectory(java.net.URI id)

Gets the quota directory by ID.

API Call: GET /file/quotadirectories/{id}

Parameters:

id - the ID of the Quota Directory

Returns:

the quota directory for the given id.

listByFileSystem

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

Lists the file quota directories for the given file system by ID.

API Call: GET /file/filesystems/{fileSystemId}/quota-directories

Parameters:

fileSystemId - the ID of the file system.

Returns:

the list of file quota directory references for the file system.

getByFileSystem

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

Gets the list of file quota directories 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 quota directories for the file system.

getByFileSystem

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

Gets the list of file quota directories 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 quota directories for the file system.