public interface SharesService extends RestService
Modifier and Type | Method and Description |
---|---|
Share |
create(ShareCreate shareCreate)
Creates a share.
|
ActionResponse |
delete(String shareId)
Deletes a share.
|
ActionResponse |
delete(String shareId,
String consistencyGroupId)
Deletes a share.
|
ActionResponse |
extend(String shareId,
int newSize)
Increases the size of a share.
|
ActionResponse |
forceDelete(String shareId)
Administrators only.
|
Share |
get(String shareId)
Shows details for a share.
|
Metadata |
getMetadata(String shareId)
Shows the metadata for a share.
|
Access |
grantAccess(String shareId,
AccessOptions options)
Grants access to a share.
|
List<? extends Share> |
list()
Lists all shares.
|
List<? extends Access> |
listAccess(String shareId)
List access rules for a share.
|
List<? extends Share> |
listDetails()
Lists all shares, with details.
|
ActionResponse |
resetState(String shareId,
Share.Status status)
Administrators only.
|
ActionResponse |
revokeAccess(String shareId,
String accessId)
Revokes access from a share.
|
Metadata |
setMetadata(String shareId,
Metadata metadata)
Sets the metadata on a share.
|
ShareCreateBuilder |
shareCreateBuilder() |
ActionResponse |
shrink(String shareId,
int newSize)
Shrinks the size of a share.
|
ActionResponse |
unsetMetadata(String shareId,
String metadataKey)
Unsets the metadata on a share.
|
Share |
update(String shareId,
ShareUpdateOptions shareUpdateOptions)
Updates a share.
|
Metadata |
updateMetadata(String shareId,
Metadata metadata)
Updates the metadata for a share.
|
Share create(ShareCreate shareCreate)
shareCreate
- the share to createList<? extends Share> listDetails()
Share get(String shareId)
shareId
- the share IDShare update(String shareId, ShareUpdateOptions shareUpdateOptions)
shareId
- the share IDshareUpdateOptions
- the options to update on the shareActionResponse delete(String shareId)
shareId
- the share IDActionResponse delete(String shareId, String consistencyGroupId)
shareId
- the share IDconsistencyGroupId
- the UUID of the consistency group where the share was createdMetadata getMetadata(String shareId)
shareId
- the share IDMetadata updateMetadata(String shareId, Metadata metadata)
shareId
- the share IDmetadata
- the metadata to updateMetadata setMetadata(String shareId, Metadata metadata)
shareId
- the share IDmetadata
- the metadata to setActionResponse unsetMetadata(String shareId, String metadataKey)
shareId
- the share IDmetadataKey
- the metadata key to unsetAccess grantAccess(String shareId, AccessOptions options)
shareId
- the share IDoptions
- the options of the granted accessActionResponse revokeAccess(String shareId, String accessId)
shareId
- the share IDaccessId
- the access ID to revokeList<? extends Access> listAccess(String shareId)
shareId
- the share IDActionResponse resetState(String shareId, Share.Status status)
shareId
- the share IDstatus
- the status to setActionResponse forceDelete(String shareId)
shareId
- the share IDActionResponse extend(String shareId, int newSize)
shareId
- the share IDnewSize
- new size of the share, in GBsActionResponse shrink(String shareId, int newSize)
shareId
- the share IDnewSize
- the new size of the share, in GBsShareCreateBuilder shareCreateBuilder()
Copyright © 2017. All rights reserved.