org.openstack4j.api.manila

Interface ShareTypeService

All Superinterfaces:

RestService

All Known Implementing Classes:

ShareTypeServiceImpl

public interface ShareTypeService
extends RestService

Share Types Service for Manila Shared Filesystems.

Author:

Daniel Gonzalez Nothnagel

Method Summary

Modifier and Type	Method and Description
ActionResponse	addShareTypeAccess(String shareTypeId, String projectId) Adds share type access for a project.
ShareType	create(ShareTypeCreate shareTypeCreate) Creates a share type.
ActionResponse	delete(String shareTypeId) Deletes a share type.
List<? extends ShareType>	list() Lists all share types.
ShareType	listDefaults() Lists default share types.
ExtraSpecs	listExtraSpecs(String shareTypeId) Lists the extra specifications for a share type.
ActionResponse	removeShareTypeAccess(String shareTypeId, String projectId) Removes share type access from a project.
ExtraSpecs	setExtraSpec(String shareTypeId, ExtraSpecs extraSpecs) Sets an extra specification for the share type.
List<? extends ShareTypeAccess>	shareTypeAccessDetails(String shareTypeId) Shows access details for a share type.
ActionResponse	unsetExtraSpec(String shareTypeId, String extraSpecKey) Unsets an extra specification for the share type.

Method Detail

create

ShareType create(ShareTypeCreate shareTypeCreate)

Creates a share type.

Parameters:

shareTypeCreate - the share type to create

Returns:

the created share type

list

List<? extends ShareType> list()

Lists all share types.

Returns:

a list of all share types

listDefaults

ShareType listDefaults()

Lists default share types.

Returns:

the default share types

delete

ActionResponse delete(String shareTypeId)

Deletes a share type.

Parameters:

shareTypeId - the share type ID

Returns:

the action response

listExtraSpecs

ExtraSpecs listExtraSpecs(String shareTypeId)

Lists the extra specifications for a share type.

Parameters:

shareTypeId - the share type ID

Returns:

a list of the extra specifications of a share type

setExtraSpec

ExtraSpecs setExtraSpec(String shareTypeId,
                        ExtraSpecs extraSpecs)

Sets an extra specification for the share type.

Parameters:

shareTypeId - the share type ID

extraSpecs - the extra specifications to set

Returns:

the extra specifications of the share type

unsetExtraSpec

ActionResponse unsetExtraSpec(String shareTypeId,
                              String extraSpecKey)

Unsets an extra specification for the share type.

Parameters:

shareTypeId - the share type ID

extraSpecKey - the key of the extra specification to unset

Returns:

the action response

addShareTypeAccess

ActionResponse addShareTypeAccess(String shareTypeId,
                                  String projectId)

Adds share type access for a project.

Parameters:

shareTypeId - the share type ID

projectId - the project ID

Returns:

the action response

removeShareTypeAccess

ActionResponse removeShareTypeAccess(String shareTypeId,
                                     String projectId)

Removes share type access from a project.

Parameters:

shareTypeId - the share type ID

projectId - the project ID

Returns:

the action response

shareTypeAccessDetails

List<? extends ShareTypeAccess> shareTypeAccessDetails(String shareTypeId)

Shows access details for a share type.

Parameters:

shareTypeId - the share type ID

Returns:

a list of all access etails of a share type