CloudFileClient Klasse

Paket:

com.microsoft.azure.storage.file

• java.lang.Object
• • ServiceClient
  • • com.microsoft.azure.storage.file.CloudFileClient

public class CloudFileClient extends ServiceClient

Stellt einen Client für den Zugriff auf den Microsoft Azure-Dateidienst bereit.

Diese Klasse bietet einen Zugriffspunkt auf den Dateidienst. Der Dienstclient kapselt den Basis-URI für den File-Dienst. Außerdem werden die Anmeldeinformationen für den Zugriff auf das Speicherkonto gekapselt.

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
CloudFileClient(final URI baseUri, StorageCredentials credentials)	Erstellt eine instance der -Klasse unter Verwendung des angegebenen Dateidienstendpunkts und der angegebenen Kontoanmeldeinformationen.
CloudFileClient(StorageUri storageUri, StorageCredentials credentials)	Erstellt eine instance der -Klasse unter Verwendung des angegebenen Dateidienstendpunkts und der angegebenen Kontoanmeldeinformationen.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
final FileServiceProperties	downloadServiceProperties() Ruft den aktuellen FileServiceProperties für den angegebenen Speicherdienst ab. Dadurch werden die CORS-Konfigurationen gekapselt.
final FileServiceProperties	downloadServiceProperties(FileRequestOptions options, OperationContext opContext) Ruft den aktuellen FileServiceProperties für den angegebenen Speicherdienst ab. Dadurch werden die CORS-Konfigurationen gekapselt.
FileRequestOptions	getDefaultRequestOptions() Ruft die ab, die für Anforderungen verwendet wird, die FileRequestOptions diesem zugeordnet sind.
CloudFileShare	getShareReference(final String shareName) Ruft ein CloudFileShare -Objekt mit dem angegebenen Namen ab.
CloudFileShare	getShareReference(final String shareName, String snapshotID) Ruft ein CloudFileShare -Objekt mit dem angegebenen Namen ab.
boolean	isUsePathStyleUris() Gibt an, ob pfadartige URIs verwendet werden.
Iterable<CloudFileShare>	listShares() Gibt eine aufzählbare Sammlung von Freigaben für diesen Dateidienstclient zurück.
Iterable<CloudFileShare>	listShares(final String prefix) Gibt eine aufzählbare Auflistung von Freigaben zurück, deren Namen mit dem angegebenen Präfix für diesen Dateidienstclient beginnen.
Iterable<CloudFileShare>	listShares(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final FileRequestOptions options, final OperationContext opContext) Gibt eine aufzählbare Auflistung von Freigaben zurück, deren Namen mit dem angegebenen Präfix für diesen Dateidienstclient beginnen, wobei die angegebenen Detaileinstellungen, Anforderungsoptionen und der Vorgangskontext verwendet werden.
ResultSegment<CloudFileShare>	listSharesSegmented() Gibt ein Ergebnissegment einer aufzählbaren Auflistung von Freigaben für diesen Dateidienstclient zurück.
ResultSegment<CloudFileShare>	listSharesSegmented(final String prefix) Gibt ein Ergebnissegment einer aufzählbaren Auflistung von Freigaben zurück, deren Namen mit dem angegebenen Präfix für diesen Dateidienstclient beginnen.
ResultSegment<CloudFileShare>	listSharesSegmented(final String prefix, final EnumSet<ShareListingDetails> detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final FileRequestOptions options, final OperationContext opContext) Gibt ein Ergebnissegment einer aufzählbaren Auflistung von Freigaben zurück, deren Namen mit dem angegebenen Präfix beginnen. Dabei werden die angegebenen Optionen für Listendetails, Anforderungsoptionen und Vorgangskontext verwendet.
void	setDefaultRequestOptions(FileRequestOptions defaultRequestOptions) Legt die fest, die FileRequestOptions für alle Anforderungen verwendet wird, die diesem Objekt zugeordnet sind.
void	uploadServiceProperties(final FileServiceProperties properties) Lädt eine neue FileServiceProperties Konfiguration in den angegebenen Speicherdienst hoch. Dadurch werden die CORS-Konfigurationen gekapselt.
void	uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options, OperationContext opContext) Lädt eine neue FileServiceProperties Konfiguration in den angegebenen Speicherdienst hoch. Dadurch werden die CORS-Konfigurationen gekapselt.

Geerbte Elemente

ServiceClient.credentials ServiceClient.downloadServicePropertiesImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getCredentials() ServiceClient.getEndpoint() ServiceClient.getServiceStatsImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getStorageUri() ServiceClient.ServiceClient(final StorageUri storageUri, final StorageCredentials credentials) ServiceClient.setCredentials(final StorageCredentials credentials) ServiceClient.setStorageUri(final StorageUri storageUri) ServiceClient.uploadServicePropertiesImpl(final ServiceProperties properties, final RequestOptions options, final OperationContext opContext, final boolean signAsTable)

Details zum Konstruktor

CloudFileClient

public CloudFileClient(final URI baseUri, StorageCredentials credentials)

Erstellt eine instance der -Klasse unter Verwendung des angegebenen Dateidienstendpunkts und der angegebenen Kontoanmeldeinformationen.

Parameters:

baseUri - Ein java.net.URI -Objekt, das den Dateidienstendpunkt darstellt, der zum Erstellen des Clients verwendet wird.

credentials - Ein StorageCredentials -Objekt, das die Kontoanmeldeinformationen darstellt.

CloudFileClient

public CloudFileClient(StorageUri storageUri, StorageCredentials credentials)

Erstellt eine instance der -Klasse unter Verwendung des angegebenen Dateidienstendpunkts und der angegebenen Kontoanmeldeinformationen.

Parameters:

storageUri - Ein StorageUri -Objekt, das den Dateidienstendpunkt darstellt, der zum Erstellen des Clients verwendet wird.

credentials - Ein StorageCredentials -Objekt, das die Kontoanmeldeinformationen darstellt.

Details zur Methode

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties()

Ruft den aktuellen FileServiceProperties für den angegebenen Speicherdienst ab. Dadurch werden die CORS-Konfigurationen gekapselt.

Returns:

Ein FileServiceProperties Objekt, das die aktuelle Konfiguration des Diensts darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

downloadServiceProperties

public final FileServiceProperties downloadServiceProperties(FileRequestOptions options, OperationContext opContext)

Ruft den aktuellen FileServiceProperties für den angegebenen Speicherdienst ab. Dadurch werden die CORS-Konfigurationen gekapselt.

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 FileServiceProperties Objekt, das die aktuelle Konfiguration des Diensts darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

getDefaultRequestOptions

public FileRequestOptions getDefaultRequestOptions()

Ruft die ab, die für Anforderungen verwendet wird, die FileRequestOptions diesem zugeordnet sind.

Returns:

Das FileRequestOptions Objekt, das die von diesem verwendeten Werte enthält CloudFileClient

getShareReference

public CloudFileShare getShareReference(final String shareName)

Ruft ein CloudFileShare -Objekt mit dem angegebenen Namen ab.

Parameters:

shareName - Der Name der Freigabe, 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.

Returns:

Ein Verweis auf ein CloudFileShare-Objekt.

Throws:

StorageException

URISyntaxException

getShareReference

public CloudFileShare getShareReference(final String shareName, String snapshotID)

Ruft ein CloudFileShare -Objekt mit dem angegebenen Namen ab.

Parameters:

shareName - Der Name der Freigabe, 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 die Momentaufnahme-ID der Freigabe darstellt.

Returns:

Ein Verweis auf ein CloudFileShare-Objekt.

Throws:

StorageException

URISyntaxException

isUsePathStyleUris

protected boolean isUsePathStyleUris()

Gibt an, ob pfadartige URIs verwendet werden.

Returns:

true bei Verwendung von PFADART-URIs; falseandernfalls .

listShares

public Iterable listShares()

Gibt eine aufzählbare Sammlung von Freigaben für diesen Dateidienstclient zurück.

Returns:

Eine aufzählbare Auflistung von CloudFileShare Objekten, die lazily abgerufen werden und die die Freigaben für diesen Client darstellen.

listShares

public Iterable listShares(final String prefix)

Gibt eine aufzählbare Auflistung von Freigaben zurück, deren Namen mit dem angegebenen Präfix für diesen Dateidienstclient beginnen.

Parameters:

prefix - Eine String , die das Präfix für den Freigabenamen darstellt.

Returns:

Eine aufzählbare Auflistung von CloudFileShare Objekten, die lazily abgerufen werden und die die Freigaben für diesen Client darstellen, deren Namen mit dem angegebenen Präfix beginnen.

listShares

public Iterable listShares(final String prefix, final EnumSet detailsIncluded, final FileRequestOptions options, final OperationContext opContext)

Gibt eine aufzählbare Auflistung von Freigaben zurück, deren Namen mit dem angegebenen Präfix für diesen Dateidienstclient beginnen, wobei die angegebenen Detaileinstellungen, Anforderungsoptionen und der Vorgangskontext verwendet werden.

Parameters:

prefix - Eine String , die das Präfix für den Freigabenamen darstellt.

detailsIncluded - Ein java.util.EnumSet Objekt, das Werte enthält ShareListingDetails , die angeben, ob Freigabemomentaufnahmen und/oder Metadaten zurückgegeben werden.

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:

Eine aufzählbare Auflistung von CloudFileShare Objekten, die lazily abgerufen werden und die die Freigaben für diesen Client darstellt.

listSharesSegmented

public ResultSegment listSharesSegmented()

Gibt ein Ergebnissegment einer aufzählbaren Auflistung von Freigaben für diesen Dateidienstclient zurück.

Returns:

Ein ResultSegment<T> -Objekt, das ein Segment der aufzählbaren Auflistung von CloudFileShare Objekten enthält, die die Freigaben für diesen Client darstellen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

listSharesSegmented

public ResultSegment listSharesSegmented(final String prefix)

Gibt ein Ergebnissegment einer aufzählbaren Auflistung von Freigaben zurück, deren Namen mit dem angegebenen Präfix für diesen Dateidienstclient beginnen.

Parameters:

prefix - Eine String , die das Präfix des Freigabenamens darstellt.

Returns:

Ein ResultSegment<T> -Objekt, das ein Segment der aufzählbaren Auflistung von CloudFileShare Objekten enthält, die die Freigaben darstellen, deren Namen mit dem angegebenen Präfix beginnen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

listSharesSegmented

public ResultSegment listSharesSegmented(final String prefix, final EnumSet detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final FileRequestOptions options, final OperationContext opContext)

Gibt ein Ergebnissegment einer aufzählbaren Auflistung von Freigaben zurück, deren Namen mit dem angegebenen Präfix beginnen. Dabei werden die angegebenen Optionen für Listendetails, Anforderungsoptionen und Vorgangskontext verwendet.

Parameters:

prefix - Eine String , die das Präfix des Freigabenamens darstellt.

detailsIncluded - Ein java.util.EnumSet Objekt, das Werte enthält ShareListingDetails , die angeben, ob Freigabemomentaufnahmen und/oder Metadaten zurückgegeben werden.

maxResults - Die maximale Anzahl der abzurufenden Ergebnisse. Wenn null oder größer als 5000, gibt der Server bis zu 5.000 Elemente zurück. Die Anzahl muss mindestens 1 sein.

continuationToken - Ein ResultContinuation -Objekt, das ein Fortsetzungstoken darstellt, das von einem vorherigen Auflistungsvorgang zurückgegeben wurde.

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 ResultSegment<T> -Objekt, das ein Segment der aufzählbaren Auflistung von CloudFileShare Objekten enthält, die die Freigaben für diesen Client darstellen.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

setDefaultRequestOptions

public void setDefaultRequestOptions(FileRequestOptions defaultRequestOptions)

Legt die fest, die FileRequestOptions für alle Anforderungen verwendet wird, die diesem Objekt zugeordnet sind.

Parameters:

defaultRequestOptions - Ein FileRequestOptions -Objekt, das die zu verwendenden Optionen angibt.

uploadServiceProperties

public void uploadServiceProperties(final FileServiceProperties properties)

Lädt eine neue FileServiceProperties Konfiguration in den angegebenen Speicherdienst hoch. Dadurch werden die CORS-Konfigurationen gekapselt.

Parameters:

properties - Ein FileServiceProperties -Objekt, das die hochzuladenden Diensteigenschaften angibt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

uploadServiceProperties

public void uploadServiceProperties(final FileServiceProperties properties, FileRequestOptions options, OperationContext opContext)

Lädt eine neue FileServiceProperties Konfiguration in den angegebenen Speicherdienst hoch. Dadurch werden die CORS-Konfigurationen gekapselt.

Parameters:

properties - Ein FileServiceProperties -Objekt, das die hochzuladenden Diensteigenschaften angibt.

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.