com.citrix.sharefile.api.entities

Class SFStorageCentersEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFStorageCentersEntity

public class SFStorageCentersEntity
extends SFEntitiesBase

Field Summary

Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

client

Constructor Summary

Constructors

Constructor and Description
SFStorageCentersEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<SFStorageCenter>	createByZone(java.net.URI url, SFStorageCenter storageCenter) Create StorageCenter { "ExternalAddress":"https://server/", "Version":"4.12.20", "HostName":"hostname" } Creates a new Storage Center associated with a specific zone
ISFQuery<SFODataFeed<SFMetadata>>	createMetadata(java.net.URI zUrl, java.lang.String scid, java.util.ArrayList<SFMetadata> metadata) Create or update StorageCenter Metadata [ {"Name":"metadataName1", "Value":"metadataValue1", "IsPublic":"true"}, {"Name":"metadataName2", "Value":"metadataValue2", "IsPublic":"false"}, ...
ISFQuery	delete(java.net.URI url) Delete Storage Center
ISFQuery	deleteByZone(java.net.URI zUrl, java.lang.String scid) Delete StorageCenter Removes an existing storage center
ISFQuery	deleteMetadata(java.net.URI zUrl, java.lang.String scid, java.lang.String name) Delete StorageCenter Metadata Delete the Metadata entry associated with the specified storage center
ISFQuery<SFStorageCenter>	get(java.net.URI url) Get Storage Center
ISFQuery<SFODataFeed<SFStorageCenter>>	getByZone(java.net.URI url) Get List of StorageCenters from Zone Lists Storage Centers of a given Zone
ISFQuery<SFODataFeed<SFMetadata>>	getMetadata(java.net.URI zUrl, java.lang.String scid) Get StorageCenter Metadata Gets metadata associated with the specified storage center
ISFQuery<SFStorageCenter>	update(java.net.URI url, SFStorageCenter sc) Patch Storage Center { "ExternalAddress":"https://server/", "Version":"4.12.20", "HostName":"hostname" }
ISFQuery<SFStorageCenter>	updateByZone(java.net.URI zUrl, java.lang.String scid, SFStorageCenter storageCenter) Update StorageCenter { "ExternalAddress":"https://server/", "Version":"4.12.20", "HostName":"hostname" } Updates an existing Storage Center

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

getEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

SFStorageCentersEntity

public SFStorageCentersEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFStorageCenter> get(java.net.URI url)
                              throws InvalidOrMissingParameterException

Get Storage Center

Parameters:

url -

Returns:

A single Storage Center

Throws:

InvalidOrMissingParameterException

update

public ISFQuery<SFStorageCenter> update(java.net.URI url,
                               SFStorageCenter sc)
                                 throws InvalidOrMissingParameterException

Patch Storage Center { "ExternalAddress":"https://server/", "Version":"4.12.20", "HostName":"hostname" }

Parameters:

url -

sc -

Returns:

Modified Storage Center

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url)
                throws InvalidOrMissingParameterException

Delete Storage Center

Parameters:

url -

Throws:

InvalidOrMissingParameterException

getByZone

public ISFQuery<SFODataFeed<SFStorageCenter>> getByZone(java.net.URI url)
                                                 throws InvalidOrMissingParameterException

Get List of StorageCenters from Zone Lists Storage Centers of a given Zone

Parameters:

url -

Returns:

A list of Storage Centers associated with the provided zone

Throws:

InvalidOrMissingParameterException

createByZone

public ISFQuery<SFStorageCenter> createByZone(java.net.URI url,
                                     SFStorageCenter storageCenter)
                                       throws InvalidOrMissingParameterException

Create StorageCenter { "ExternalAddress":"https://server/", "Version":"4.12.20", "HostName":"hostname" } Creates a new Storage Center associated with a specific zone

Parameters:

url -

storageCenter -

Returns:

The new storage center

Throws:

InvalidOrMissingParameterException

updateByZone

public ISFQuery<SFStorageCenter> updateByZone(java.net.URI zUrl,
                                     java.lang.String scid,
                                     SFStorageCenter storageCenter)
                                       throws InvalidOrMissingParameterException

Update StorageCenter { "ExternalAddress":"https://server/", "Version":"4.12.20", "HostName":"hostname" } Updates an existing Storage Center

Parameters:

zUrl -

storageCenter -

Returns:

the modified storage center

Throws:

InvalidOrMissingParameterException

deleteByZone

public ISFQuery deleteByZone(java.net.URI zUrl,
                    java.lang.String scid)
                      throws InvalidOrMissingParameterException

Delete StorageCenter Removes an existing storage center

Parameters:

zUrl -

Throws:

InvalidOrMissingParameterException

getMetadata

public ISFQuery<SFODataFeed<SFMetadata>> getMetadata(java.net.URI zUrl,
                                            java.lang.String scid)
                                              throws InvalidOrMissingParameterException

Get StorageCenter Metadata Gets metadata associated with the specified storage center

Parameters:

zUrl -

Returns:

the storage center metadata feed

Throws:

InvalidOrMissingParameterException

createMetadata

public ISFQuery<SFODataFeed<SFMetadata>> createMetadata(java.net.URI zUrl,
                                               java.lang.String scid,
                                               java.util.ArrayList<SFMetadata> metadata)
                                                 throws InvalidOrMissingParameterException

Create or update StorageCenter Metadata [ {"Name":"metadataName1", "Value":"metadataValue1", "IsPublic":"true"}, {"Name":"metadataName2", "Value":"metadataValue2", "IsPublic":"false"}, ... ] Creates or updates Metadata entries associated with the specified storage center

Parameters:

zUrl -

metadata -

Returns:

the storage center metadata feed

Throws:

InvalidOrMissingParameterException

deleteMetadata

public ISFQuery deleteMetadata(java.net.URI zUrl,
                      java.lang.String scid,
                      java.lang.String name)
                        throws InvalidOrMissingParameterException

Delete StorageCenter Metadata Delete the Metadata entry associated with the specified storage center

Parameters:

zUrl -

name -

Returns:

no data on success

Throws:

InvalidOrMissingParameterException