CloudFileShare Klasse

Paket:

com.microsoft.azure.storage.file

• java.lang.Object
• • com.microsoft.azure.storage.file.CloudFileShare

public class CloudFileShare

Stellt eine Freigabe im Microsoft Azure-Dateidienst dar.

Freigaben enthalten Verzeichnisse, die als CloudFileDirectory Objekte gekapselt werden, und Verzeichnisse enthalten Dateien. Die Verzeichnisse können auch Unterverzeichnisse enthalten.

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
CloudFileShare(final StorageUri storageUri)	Erstellt eine instance der -Klasse unter Verwendung des angegebenen URI.
CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)	Erstellt eine instance der -Klasse unter Verwendung des angegebenen StorageUri und der angegebenen Anmeldeinformationen.
CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)	Erstellt eine instance der -Klasse unter Verwendung des angegebenen Namens und des angegebenen Clients.
CloudFileShare(final URI uri)	Erstellt eine instance der -Klasse unter Verwendung des angegebenen URI.
CloudFileShare(final URI uri, final StorageCredentials credentials)	Erstellt eine instance der -Klasse unter Verwendung des angegebenen URI und der angegebenen Anmeldeinformationen.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
void	assertNoSnapshot() Stellt fest, dass die Freigabe kein Momentaufnahme ist.
void	create() Erstellt die Freigabe.
void	create(FileRequestOptions options, OperationContext opContext) Erstellt die Freigabe mit den angegebenen Optionen und dem angegebenen Vorgangskontext.
String	createFilePermission(String permission) Erstellt eine Dateiberechtigung.
String	createFilePermission(String permission, FileRequestOptions options, OperationContext opContext) Erstellt eine Dateiberechtigung.
boolean	createIfNotExists() Erstellt die Freigabe, wenn sie nicht vorhanden ist.
boolean	createIfNotExists(FileRequestOptions options, OperationContext opContext) Erstellt die Freigabe, wenn sie nicht vorhanden ist, und verwendet die angegebenen Anforderungsoptionen und den angegebenen Vorgangskontext.
final CloudFileShare	createSnapshot() Erstellt eine Momentaufnahme der Freigabe.
final CloudFileShare	createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Erstellt eine Momentaufnahme der Dateifreigabe unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.
final CloudFileShare	createSnapshot(final HashMap<String, String> metadata, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Erstellt eine Momentaufnahme der Dateifreigabe unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.
void	delete() Löscht die Freigabe.
void	delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Löscht die Freigabe mithilfe der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.
void	delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Löscht die Freigabe mithilfe der angegebenen Momentaufnahme- und Anforderungsoptionen sowie des Vorgangskontexts. Eine Freigabe mit Momentaufnahmen kann nur gelöscht werden, wenn die Momentaufnahmen ebenfalls gelöscht werden. Wenn eine Freigabe Über Momentaufnahmen verfügt, verwenden Sie den INCLUDE_SNAPSHOTS Wert im Parameter, um die Momentaufnahmen beim Löschen der Basisfreigabe einzuschließen.
boolean	deleteIfExists() Löscht die Freigabe, sofern vorhanden.
boolean	deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Löscht die Freigabe, wenn sie vorhanden ist, unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.
boolean	deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Löscht die Freigabe, sofern vorhanden, unter Verwendung der angegebenen Momentaufnahme- und Anforderungsoptionen sowie des Vorgangskontexts. Eine Freigabe mit Momentaufnahmen kann nur gelöscht werden, wenn die Momentaufnahmen ebenfalls gelöscht werden. Wenn eine Freigabe Über Momentaufnahmen verfügt, verwenden Sie den INCLUDE_SNAPSHOTS Wert im Parameter, um die Momentaufnahmen beim Löschen der Basisfreigabe einzuschließen.
void	downloadAttributes() Lädt die Attribute der Freigabe herunter, die aus Metadaten und Eigenschaften bestehen.
void	downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Lädt die Attribute der Freigabe herunter, die aus Metadaten und Eigenschaften bestehen, und verwendet dabei die angegebenen Anforderungsoptionen und den angegebenen Vorgangskontext.
FileSharePermissions	downloadPermissions() Lädt die Berechtigungseinstellungen für die Freigabe herunter.
FileSharePermissions	downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Lädt die Berechtigungseinstellungen für die Freigabe mithilfe der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts herunter.
boolean	exists() Gibt einen Wert zurück, der angibt, ob die Freigabe vorhanden ist.
boolean	exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Gibt einen Wert zurück, der angibt, ob die Freigabe vorhanden ist, wobei die angegebenen Anforderungsoptionen und der angegebene Vorgangskontext verwendet werden.
String	generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier) Gibt eine Shared Access Signature für die Freigabe zurück. Beachten Sie, dass dies nicht das führende "?" enthält.
String	generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols) Gibt eine Shared Access Signature für die Freigabe zurück. Beachten Sie, dass dies nicht das führende "?" enthält.
String	getFilePermission(String filePermissionKey) Ruft die Dateiberechtigung ab, die einem Dateiberechtigungsschlüssel zugeordnet ist.
String	getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext) Ruft die Dateiberechtigung ab, die einem Dateiberechtigungsschlüssel zugeordnet ist.
HashMap<String, String>	getMetadata() Gibt die Metadaten für die Freigabe zurück. Dieser Wert wird mit den Metadaten aus der Freigabe durch einen Aufruf downloadAttributes()von initialisiert und für die Freigabe mit einem Aufruf von uploadMetadata()festgelegt.
String	getName() Gibt den Namen der Freigabe zurück.
FileShareProperties	getProperties() Gibt die Eigenschaften für die Freigabe zurück.
final URI	getQualifiedUri() Gibt den Momentaufnahme oder freigegebenen Zugriffssignatur-qualifizierten URI für diese Freigabe zurück.
CloudFileDirectory	getRootDirectoryReference() Gibt einen Verweis auf ein CloudFileDirectory -Objekt zurück, das das Stammdateiverzeichnis innerhalb dieser Freigabe darstellt.
CloudFileClient	getServiceClient() Gibt den Dieser Freigabe zugeordneten Dateidienstclient zurück.
final String	getSnapshot() Gibt die snapshotID für diese Freigabe zurück.
ShareStats	getStats() Fragt den Dienst für die Freigabe ab ShareStats.
ShareStats	getStats(FileRequestOptions options, OperationContext opContext) Fragt den Dienst für die Freigabe ab ShareStats.
StorageUri	getStorageUri() Gibt die Liste der URIs für alle Speicherorte zurück.
URI	getUri() Gibt den URI für diese Freigabe zurück.
final boolean	isSnapshot() Gibt an, ob es sich bei dieser Freigabe um eine Momentaufnahme handelt.
void	setMetadata(final HashMap<String, String> metadata) Legt die Metadatensammlung von Name-Wert-Paaren fest, die für die Freigabe mit einem uploadMetadata() Aufruf festgelegt werden sollen. Diese Sammlung überschreibt alle vorhandenen Freigabemetadaten. Wenn dies auf eine leere Auflistung festgelegt ist, werden die Freigabemetadaten bei einem uploadMetadata() Aufruf gelöscht.
void	setProperties(final FileShareProperties properties) Legt die Eigenschaften für die Freigabe fest.
void	uploadMetadata() Lädt die Metadaten der Freigabe hoch.
void	uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Lädt die Metadaten der Freigabe mithilfe der angegebenen Anforderungsoptionen und des Vorgangskontexts hoch.
void	uploadPermissions(final FileSharePermissions permissions) Lädt die Berechtigungen der Freigabe hoch.
void	uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Lädt die Berechtigungen der Freigabe mithilfe der angegebenen Anforderungsoptionen und des Vorgangskontexts hoch.
final void	uploadProperties() Updates die Eigenschaften der Freigabe für den Speicherdienst. Verwenden Sie downloadAttributes() , um die neuesten Werte für die Eigenschaften und Metadaten der Freigabe aus dem Microsoft Azure-Speicherdienst abzurufen.
final void	uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) Updates die Eigenschaften der Freigabe mithilfe der Anforderungsoptionen und des Vorgangskontexts. Verwenden Sie downloadAttributes() , um die neuesten Werte für die Eigenschaften und Metadaten der Freigabe aus dem Microsoft Azure-Speicherdienst abzurufen.

Details zum Konstruktor

CloudFileShare

public CloudFileShare(final StorageUri storageUri)

Erstellt eine instance der -Klasse unter Verwendung des angegebenen URI.

Parameters:

storageUri - Ein StorageUri -Objekt, das den absoluten URI der Freigabe darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

CloudFileShare

public CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)

Erstellt eine instance der -Klasse unter Verwendung des angegebenen StorageUri und der angegebenen Anmeldeinformationen.

Parameters:

storageUri - Ein StorageUri -Objekt, das den absoluten StorageUri der Freigabe darstellt.

credentials - Ein StorageCredentials Objekt, das zum Authentifizieren des Zugriffs verwendet wird.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

CloudFileShare

public CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)

Erstellt eine instance der -Klasse unter Verwendung des angegebenen Namens und des angegebenen Clients.

Parameters:

shareName - Ein String , der den Namen der Freigabe darstellt, die den Freigabenamensregeln entsprechen muss. Der Freigabename sollte keine Pfadtrennzeichen (/) enthalten. Freigabenamen müssen kleingeschrieben sein, zwischen 3 und 63 Zeichen lang sein und mit einem Buchstaben oder einer Zahl beginnen. Freigabenamen dürfen nur Buchstaben, Zahlen und das Bindestrichzeichen (-) enthalten.

snapshotID - EineString, die ggf. die Momentaufnahme Version darstellt.

client - Ein CloudFileClient -Objekt, das den zugeordneten Dienstclient darstellt und den Endpunkt für den Dateidienst angibt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

URISyntaxException - Wenn der ressourcenbasierte URI, der auf shareName erstellt wurde, ungültig ist.

CloudFileShare

public CloudFileShare(final URI uri)

Erstellt eine instance der -Klasse unter Verwendung des angegebenen URI.

Parameters:

uri - Ein java.net.URI -Objekt, das den absoluten URI der Freigabe darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

CloudFileShare

public CloudFileShare(final URI uri, final StorageCredentials credentials)

Erstellt eine instance der -Klasse unter Verwendung des angegebenen URI und der angegebenen Anmeldeinformationen.

Parameters:

uri - Ein java.net.URI -Objekt, das den absoluten URI der Freigabe darstellt.

credentials - Ein StorageCredentials Objekt, das zum Authentifizieren des Zugriffs verwendet wird.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

Details zur Methode

assertNoSnapshot

protected void assertNoSnapshot()

Stellt fest, dass die Freigabe kein Momentaufnahme ist.

create

public void create()

Erstellt die Freigabe.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

create

public void create(FileRequestOptions options, OperationContext opContext)

Erstellt die Freigabe mit den angegebenen Optionen und dem angegebenen Vorgangskontext.

Parameters:

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

createFilePermission

public String createFilePermission(String permission)

Erstellt eine Dateiberechtigung.

Parameters:

permission - Ein String -Objekt, das die zu erstellende Dateiberechtigung darstellt.

Returns:

Stellt String den Dateiberechtigungsschlüssel dar, der der erstellten Dateiberechtigung zugeordnet ist.

Throws:

StorageException

IOException

createFilePermission

public String createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)

Erstellt eine Dateiberechtigung.

Parameters:

permission - Ein String -Objekt, das die zu erstellende Dateiberechtigung darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Returns:

Stellt String den Dateiberechtigungsschlüssel dar, der der erstellten Dateiberechtigung zugeordnet ist.

Throws:

StorageException

IOException

createIfNotExists

public boolean createIfNotExists()

Erstellt die Freigabe, wenn sie nicht vorhanden ist.

Returns:

true, wenn die Freigabe noch nicht vorhanden war und erstellt wurde; andernfalls false.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

createIfNotExists

public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)

Erstellt die Freigabe, wenn sie nicht vorhanden ist, und verwendet die angegebenen Anforderungsoptionen und den angegebenen Vorgangskontext.

Parameters:

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients (CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Returns:

true, wenn die Freigabe noch nicht vorhanden war und erstellt wurde; andernfalls false.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

createSnapshot

public final CloudFileShare createSnapshot()

Erstellt eine Momentaufnahme der Freigabe.

Returns:

Ein CloudFileShare -Objekt, das die Momentaufnahme der Freigabe darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

createSnapshot

public final CloudFileShare createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Erstellt eine Momentaufnahme der Dateifreigabe unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.

Parameters:

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Freigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Returns:

Ein CloudFileShare -Objekt, das die Momentaufnahme der Dateifreigabe darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

createSnapshot

public final CloudFileShare createSnapshot(final HashMap metadata, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Erstellt eine Momentaufnahme der Dateifreigabe unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.

Parameters:

metadata - Eine Auflistung von Name-Wert-Paaren, die die Metadaten der Momentaufnahme oder NULL definieren.

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Dateifreigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Returns:

Ein CloudFileShare -Objekt, das die Momentaufnahme der Dateifreigabe darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

delete

public void delete()

Löscht die Freigabe.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

delete

public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Löscht die Freigabe mithilfe der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.

Parameters:

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Freigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

delete

public void delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Löscht die Freigabe mithilfe der angegebenen Momentaufnahme- und Anforderungsoptionen sowie des Vorgangskontexts.

Eine Freigabe mit Momentaufnahmen kann nur gelöscht werden, wenn die Momentaufnahmen ebenfalls gelöscht werden. Wenn eine Freigabe Über Momentaufnahmen verfügt, verwenden Sie den INCLUDE_SNAPSHOTS Wert im Parameter, um die Momentaufnahmen beim Löschen der Basisfreigabe einzuschließen.

Parameters:

deleteSnapshotsOption - Ein DeleteShareSnapshotsOption -Objekt, das angibt, ob nur Momentaufnahmen oder die Freigabe und die zugehörigen Momentaufnahmen gelöscht werden sollen.

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Freigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

deleteIfExists

public boolean deleteIfExists()

Löscht die Freigabe, sofern vorhanden.

Returns:

true , wenn die Freigabe vorhanden war und gelöscht wurde; falseandernfalls .

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

deleteIfExists

public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Löscht die Freigabe, wenn sie vorhanden ist, unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.

Parameters:

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Freigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Returns:

true , wenn die Freigabe vorhanden war und gelöscht wurde; falseandernfalls .

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

deleteIfExists

public boolean deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Löscht die Freigabe, sofern vorhanden, unter Verwendung der angegebenen Momentaufnahme- und Anforderungsoptionen sowie des Vorgangskontexts.

Eine Freigabe mit Momentaufnahmen kann nur gelöscht werden, wenn die Momentaufnahmen ebenfalls gelöscht werden. Wenn eine Freigabe Über Momentaufnahmen verfügt, verwenden Sie den INCLUDE_SNAPSHOTS Wert im Parameter, um die Momentaufnahmen beim Löschen der Basisfreigabe einzuschließen.

Parameters:

deleteSnapshotsOption - Ein DeleteShareSnapshotsOption -Objekt, das angibt, ob nur Momentaufnahmen oder die Freigabe und die zugehörigen Momentaufnahmen gelöscht werden sollen.

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Freigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Returns:

true , wenn die Freigabe vorhanden war und gelöscht wurde; falseandernfalls .

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

downloadAttributes

public void downloadAttributes()

Lädt die Attribute der Freigabe herunter, die aus Metadaten und Eigenschaften bestehen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

downloadAttributes

public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Lädt die Attribute der Freigabe herunter, die aus Metadaten und Eigenschaften bestehen, und verwendet dabei die angegebenen Anforderungsoptionen und den angegebenen Vorgangskontext.

Parameters:

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Freigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

downloadPermissions

public FileSharePermissions downloadPermissions()

Lädt die Berechtigungseinstellungen für die Freigabe herunter.

Returns:

Ein FileSharePermissions -Objekt, das die Berechtigungen der Freigabe darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

downloadPermissions

public FileSharePermissions downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Lädt die Berechtigungseinstellungen für die Freigabe mithilfe der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts herunter.

Parameters:

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Freigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Returns:

Ein FileSharePermissions -Objekt, das die Berechtigungen der Freigabe darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

exists

public boolean exists()

Gibt einen Wert zurück, der angibt, ob die Freigabe vorhanden ist.

Returns:

true , wenn die Freigabe vorhanden ist, andernfalls false.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

exists

public boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Gibt einen Wert zurück, der angibt, ob die Freigabe vorhanden ist, wobei die angegebenen Anforderungsoptionen und der angegebene Vorgangskontext verwendet werden.

Parameters:

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Freigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Returns:

true , wenn die Freigabe vorhanden ist, andernfalls false.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)

Gibt eine Shared Access Signature für die Freigabe zurück. Beachten Sie, dass dies nicht das führende "?" enthält.

Parameters:

policy - Ein SharedAccessFilePolicy -Objekt, das die Zugriffsrichtlinie für die Shared Access Signature darstellt.

groupPolicyIdentifier - Ein String , der die Zugriffsrichtlinie auf Freigabeebene darstellt.

Returns:

Ein String , der eine Shared Access Signature für die Freigabe darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

InvalidKeyException - Wenn der Schlüssel ungültig ist.

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

Gibt eine Shared Access Signature für die Freigabe zurück. Beachten Sie, dass dies nicht das führende "?" enthält.

Parameters:

policy - Ein SharedAccessFilePolicy -Objekt, das die Zugriffsrichtlinie für die Shared Access Signature darstellt.

groupPolicyIdentifier - Ein String , der die Zugriffsrichtlinie auf Freigabeebene darstellt.

ipRange - Ein IPRange -Objekt, das den Bereich der zulässigen IP-Adressen enthält.

protocols - Ein SharedAccessProtocols , der die zulässigen Internetprotokolle darstellt.

Returns:

Ein String , der eine Shared Access Signature für die Freigabe darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

InvalidKeyException - Wenn der Schlüssel ungültig ist.

getFilePermission

public String getFilePermission(String filePermissionKey)

Ruft die Dateiberechtigung ab, die einem Dateiberechtigungsschlüssel zugeordnet ist.

Parameters:

filePermissionKey - Ein String -Objekt, das den Dateiberechtigungsschlüssel darstellt.

Returns:

Die String , die die Dateiberechtigung darstellt, die dem Dateiberechtigungsschlüssel zugeordnet ist.

Throws:

StorageException

getFilePermission

public String getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)

Ruft die Dateiberechtigung ab, die einem Dateiberechtigungsschlüssel zugeordnet ist.

Parameters:

filePermissionKey - Ein String -Objekt, das den Dateiberechtigungsschlüssel darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Returns:

Die String , die die Dateiberechtigung darstellt, die dem Dateiberechtigungsschlüssel zugeordnet ist.

Throws:

StorageException

getMetadata

public HashMap getMetadata()

Gibt die Metadaten für die Freigabe zurück. Dieser Wert wird mit den Metadaten aus der Freigabe durch einen Aufruf downloadAttributes()von initialisiert und für die Freigabe mit einem Aufruf von uploadMetadata()festgelegt.

Returns:

Ein java.util.HashMap -Objekt, das die Metadaten für die Freigabe darstellt.

getName

public String getName()

Gibt den Namen der Freigabe zurück.

Returns:

Ein String , der den Namen der Freigabe darstellt.

getProperties

public FileShareProperties getProperties()

Gibt die Eigenschaften für die Freigabe zurück.

Returns:

Ein FileShareProperties -Objekt, das die Eigenschaften für die Freigabe darstellt.

getQualifiedUri

public final URI getQualifiedUri()

Gibt den Momentaufnahme oder freigegebenen Zugriffssignatur-qualifizierten URI für diese Freigabe zurück.

Returns:

Ein java.net.URI -Objekt, das die Momentaufnahme- oder Shared Access Signature darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

URISyntaxException - Wenn der Ressourcen-URI ungültig ist.

getRootDirectoryReference

public CloudFileDirectory getRootDirectoryReference()

Gibt einen Verweis auf ein CloudFileDirectory -Objekt zurück, das das Stammdateiverzeichnis innerhalb dieser Freigabe darstellt.

Returns:

Ein CloudFileDirectory Verweis auf das Stammverzeichnis für diese Freigabe.

Throws:

StorageException

URISyntaxException

getServiceClient

public CloudFileClient getServiceClient()

Gibt den Dieser Freigabe zugeordneten Dateidienstclient zurück.

Returns:

Ein CloudFileClient -Objekt, das den dieser Freigabe zugeordneten Dienstclient darstellt.

getSnapshot

public final String getSnapshot()

Gibt die snapshotID für diese Freigabe zurück.

Returns:

Die snapshotID als Zeichenfolge für diese Freigabe.

getStats

public ShareStats getStats()

Fragt den Dienst für die Freigabe ab ShareStats.

Returns:

Ein ShareStats Objekt für den angegebenen Speicherdienst.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

getStats

public ShareStats getStats(FileRequestOptions options, OperationContext opContext)

Fragt den Dienst für die Freigabe ab ShareStats.

Parameters:

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients (CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Returns:

Ein ShareStats Objekt für den angegebenen Speicherdienst.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

getStorageUri

public StorageUri getStorageUri()

Gibt die Liste der URIs für alle Speicherorte zurück.

Returns:

Ein StorageUri -Objekt, das die Liste der URIs für alle Standorte darstellt.

getUri

public URI getUri()

Gibt den URI für diese Freigabe zurück.

Returns:

Der absolute URI zur Freigabe.

isSnapshot

public final boolean isSnapshot()

Gibt an, ob es sich bei dieser Freigabe um eine Momentaufnahme handelt.

Returns:

true, wenn die Freigabe ein Momentaufnahme ist, andernfalls false.

setMetadata

public void setMetadata(final HashMap metadata)

Legt die Metadatensammlung von Name-Wert-Paaren fest, die für die Freigabe mit einem uploadMetadata() Aufruf festgelegt werden sollen. Diese Sammlung überschreibt alle vorhandenen Freigabemetadaten. Wenn dies auf eine leere Auflistung festgelegt ist, werden die Freigabemetadaten bei einem uploadMetadata() Aufruf gelöscht.

Parameters:

metadata - Ein java.util.HashMap -Objekt, das die Metadaten darstellt, die der Freigabe zugewiesen werden.

setProperties

public void setProperties(final FileShareProperties properties)

Legt die Eigenschaften für die Freigabe fest.

Parameters:

properties - Ein FileShareProperties -Objekt, das die Eigenschaften darstellt, die der Freigabe zugewiesen werden.

uploadMetadata

public void uploadMetadata()

Lädt die Metadaten der Freigabe hoch.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

uploadMetadata

public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Lädt die Metadaten der Freigabe mithilfe der angegebenen Anforderungsoptionen und des Vorgangskontexts hoch.

Parameters:

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Freigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

uploadPermissions

public void uploadPermissions(final FileSharePermissions permissions)

Lädt die Berechtigungen der Freigabe hoch.

Parameters:

permissions - Ein FileSharePermissions -Objekt, das die Berechtigungen zum Hochladen darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

uploadPermissions

public void uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Lädt die Berechtigungen der Freigabe mithilfe der angegebenen Anforderungsoptionen und des Vorgangskontexts hoch.

Parameters:

permissions - Ein FileSharePermissions -Objekt, das die Berechtigungen zum Hochladen darstellt.

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Freigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

uploadProperties

public final void uploadProperties()

Updates die Eigenschaften der Freigabe für den Speicherdienst.

Verwenden Sie downloadAttributes() , um die neuesten Werte für die Eigenschaften und Metadaten der Freigabe aus dem Microsoft Azure-Speicherdienst abzurufen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

uploadProperties

public final void uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Updates die Eigenschaften der Freigabe mithilfe der Anforderungsoptionen und des Vorgangskontexts.

Verwenden Sie downloadAttributes() , um die neuesten Werte für die Eigenschaften und Metadaten der Freigabe aus dem Microsoft Azure-Speicherdienst abzurufen.

Parameters:

accessCondition - Ein AccessCondition -Objekt, das die Zugriffsbedingungen für die Freigabe darstellt.

options - Ein FileRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudFileClient) verwendet.

opContext - Ein OperationContext-Objekt, das den Kontext für den aktuellen Vorgang darstellt. Dieses Objekt wird verwendet, um an den Speicherdienst gerichtete Anforderungen nachzuverfolgen und um zusätzliche Laufzeitinformationen zum Vorgang bereitzustellen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.