CloudQueue Klasse

  • Referenz
Paket:
com.microsoft.azure.storage.queue
  • java.lang.Object
    • com.microsoft.azure.storage.queue.CloudQueue

public class CloudQueue

Diese Klasse stellt eine Warteschlange im Microsoft Azure Queue-Dienst dar.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
CloudQueue(final StorageUri uri)

Erstellt eine instance der -Klasse unter Verwendung der angegebenen Warteschlange . Die Warteschlange muss ein SAS-Token enthalten.
CloudQueue(final StorageUri uri, final StorageCredentials credentials)

Erstellt eine instance der -Klasse unter Verwendung der angegebenen Warteschlange und der angegebenen Anmeldeinformationen. Wenn das ein SAS-Token enthält, müssen die Anmeldeinformationen sein.
CloudQueue(final String queueName, final CloudQueueClient client)

Erstellt eine instance der -Klasse unter Verwendung des angegebenen Namens und Clients.
CloudQueue(final URI uri)

Erstellt eine instance der -Klasse unter Verwendung des angegebenen Warteschlangen-URI. Die Warteschlange muss ein SAS-Token enthalten.
CloudQueue(final URI uri, final StorageCredentials credentials)

Erstellt eine instance der -Klasse unter Verwendung der angegebenen Warteschlange und der angegebenen Anmeldeinformationen. Wenn das ein SAS-Token enthält, müssen die Anmeldeinformationen sein.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
void addMessage(final CloudQueueMessage message)

Fügt eine Nachricht auf der Rückseite der Warteschlange hinzu.
void addMessage(final CloudQueueMessage message, final int timeToLiveInSeconds, final int initialVisibilityDelayInSeconds, QueueRequestOptions options, OperationContext opContext)

Fügt eine Nachricht auf der Rückseite der Warteschlange mit den angegebenen Optionen hinzu.
void clear()

Löscht alle Nachrichten aus der Warteschlange.
void clear(QueueRequestOptions options, OperationContext opContext)

Löscht alle Nachrichten aus der Warteschlange unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.
void create()

Erstellt die Warteschlange.
void create(QueueRequestOptions options, OperationContext opContext)

Erstellt die Warteschlange unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.
boolean createIfNotExists()

Erstellt die Warteschlange, falls sie noch nicht vorhanden ist.
boolean createIfNotExists(QueueRequestOptions options, OperationContext opContext)

Erstellt die Warteschlange, wenn sie noch nicht vorhanden ist, unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.
void delete()

Löscht die Warteschlange.
void delete(QueueRequestOptions options, OperationContext opContext)

Löscht die Warteschlange unter Verwendung der angegebenen Anforderungsoptionen und des Vorgangskontexts.
boolean deleteIfExists()

Löscht die Warteschlange, falls vorhanden.
boolean deleteIfExists(QueueRequestOptions options, OperationContext opContext)

Löscht die Warteschlange, sofern sie vorhanden ist, unter Verwendung der angegebenen Anforderungsoptionen und des Vorgangskontexts.
void deleteMessage(final CloudQueueMessage message)

Löscht die angegebene Nachricht aus der Warteschlange.
void deleteMessage(final CloudQueueMessage message, QueueRequestOptions options, OperationContext opContext)

Löscht die angegebene Nachricht unter Verwendung der angegebenen Anforderungsoptionen und des Vorgangskontexts aus der Warteschlange.
void downloadAttributes()

Lädt die Metadaten und den ungefähren Wert der Nachrichtenanzahl der Warteschlange herunter.
void downloadAttributes(QueueRequestOptions options, OperationContext opContext)

Lädt die Metadaten und den ungefähren Wert der Nachrichtenanzahl der Warteschlange mithilfe der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts herunter.
QueuePermissions downloadPermissions()

Lädt die Berechtigungseinstellungen für die Warteschlange herunter.
QueuePermissions downloadPermissions(QueueRequestOptions options, OperationContext opContext)

Lädt die Berechtigungseinstellungen für die Warteschlange mithilfe der angegebenen Anforderungsoptionen und des Vorgangskontexts herunter.
boolean exists()

Gibt einen Wert zurück, der angibt, ob die Warteschlange vorhanden ist.
boolean exists(QueueRequestOptions options, OperationContext opContext)

Gibt einen Wert zurück, der angibt, ob die Warteschlange vorhanden ist, indem die angegebenen Anforderungsoptionen und der angegebene Vorgangskontext verwendet werden.
String generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier)

Gibt eine SAS (Shared Access Signature, Signatur für den gemeinsamen Zugriff) für die Warteschlange zurück.
String generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

Gibt eine SAS (Shared Access Signature, Signatur für den gemeinsamen Zugriff) für die Warteschlange zurück.
long getApproximateMessageCount()

Ruft die ungefähre Anzahl der Nachrichten der Warteschlange ab. Dieser Wert wird durch eine Anforderung an downloadAttributes() initialisiert und stellt die ungefähre Nachrichtenanzahl dar, wenn diese Anforderung abgeschlossen wurde.
HashMap<String, String> getMetadata()

Ruft die Metadatenauflistung für die Warteschlange ab, die in diesem Objekt gespeichert ist. Dieser Wert wird mit den Metadaten aus der Warteschlange durch einen Aufruf downloadAttributes()von initialisiert und für die Warteschlange mit einem Aufruf von uploadMetadata()festgelegt.
String getName()

Ruft den Namen der Warteschlange ab.
CloudQueueClient getServiceClient()

Ruft den dieser Warteschlange zugeordneten Warteschlangendienstclient ab.
boolean getShouldEncodeMessage()

Ruft den Wert ab, der angibt, ob die Nachricht base64-codiert sein soll.
final StorageUri getStorageUri()

Gibt die Liste der URIs für alle Speicherorte zurück.
URI getUri()

Ruft den absoluten URI für diese Warteschlange ab.
CloudQueueMessage peekMessage()

Es wird eine Nachricht aus der Warteschlange angezeigt. Eine Vorschauanforderung ruft eine Nachricht von der Vorderseite der Warteschlange ab, ohne die Sichtbarkeit zu ändern.
CloudQueueMessage peekMessage(final QueueRequestOptions options, final OperationContext opContext)

Mit den angegebenen Anforderungsoptionen und dem Vorgangskontext wird eine Nachricht aus der Warteschlange angezeigt. Eine Vorschauanforderung ruft eine Nachricht von der Vorderseite der Warteschlange ab, ohne die Sichtbarkeit zu ändern.
Iterable<CloudQueueMessage> peekMessages(final int numberOfMessages)

Zeigt eine angegebene Anzahl von Nachrichten aus der Warteschlange an. Eine Vorschauanforderung ruft Nachrichten von der Front der Warteschlange ab, ohne ihre Sichtbarkeit zu ändern.
Iterable<CloudQueueMessage> peekMessages(final int numberOfMessages, QueueRequestOptions options, OperationContext opContext)

Mit den angegebenen Anforderungsoptionen und dem Vorgangskontext wird ein Satz von Nachrichten aus der Warteschlange angezeigt. Eine Vorschauanforderung ruft Nachrichten von der Front der Warteschlange ab, ohne ihre Sichtbarkeit zu ändern.
CloudQueueMessage retrieveMessage()

Ruft eine Nachricht von der Vorderseite der Warteschlange mithilfe der Standardanforderungsoptionen ab. Mit diesem Vorgang wird die abgerufene Nachricht in der Warteschlange für den standardmäßigen Timeoutzeitraum der Sichtbarkeit als unsichtbar markiert.
CloudQueueMessage retrieveMessage(final int visibilityTimeoutInSeconds, final QueueRequestOptions options, final OperationContext opContext)

Ruft eine Nachricht von der Vorderseite der Warteschlange ab, wobei die angegebenen Anforderungsoptionen und der angegebene Vorgangskontext verwendet werden. Dieser Vorgang markiert die abgerufene Nachricht als unsichtbar in der Warteschlange für den angegebenen Timeoutzeitraum der Sichtbarkeit.
Iterable<CloudQueueMessage> retrieveMessages(final int numberOfMessages)

Ruft die angegebene Anzahl von Nachrichten von der Front der Warteschlange mithilfe der Standardanforderungsoptionen ab. Mit diesem Vorgang werden die abgerufenen Nachrichten in der Warteschlange für den standardmäßigen Timeoutzeitraum der Sichtbarkeit als unsichtbar markiert.
Iterable<CloudQueueMessage> retrieveMessages(final int numberOfMessages, final int visibilityTimeoutInSeconds, QueueRequestOptions options, OperationContext opContext)

Ruft die angegebene Anzahl von Nachrichten von der Front der Warteschlange unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts ab. Mit diesem Vorgang werden die abgerufenen Nachrichten in der Warteschlange für den standardmäßigen Timeoutzeitraum der Sichtbarkeit als unsichtbar markiert.
void setMetadata(final HashMap<String, String> metadata)

Legt die Metadatenauflistung von Name-Wert-Paaren fest, die in der Warteschlange mit einem uploadMetadata() Aufruf festgelegt werden sollen. Diese Sammlung überschreibt alle vorhandenen Warteschlangenmetadaten. Wenn dies auf eine leere Auflistung festgelegt ist, werden die Warteschlangenmetadaten bei einem uploadMetadata() Aufruf gelöscht.
void setShouldEncodeMessage(final boolean shouldEncodeMessage)

Legt das Flag fest, das angibt, ob die Nachricht base64-codiert sein soll.
void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds)

Updates die angegebene Nachricht in der Warteschlange mit einem neuen Timeoutwert für die Sichtbarkeit in Sekunden.
void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds, final EnumSet<MessageUpdateFields> messageUpdateFields, QueueRequestOptions options, OperationContext opContext)

Updates eine Nachricht in der Warteschlange mithilfe der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.
void uploadMetadata()

Lädt die Metadaten im Objekt in die Warteschlange hoch.
void uploadMetadata(QueueRequestOptions options, OperationContext opContext)

Lädt die Metadaten im Objekt mithilfe der angegebenen Anforderungsoptionen und des Vorgangskontexts in die Warteschlange hoch.
void uploadPermissions(final QueuePermissions permissions)

Lädt die Berechtigungen der Warteschlange hoch.
void uploadPermissions(final QueuePermissions permissions, QueueRequestOptions options, OperationContext opContext)

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

Details zum Konstruktor

CloudQueue

public CloudQueue(final StorageUri uri)

Erstellt eine instance der -Klasse unter Verwendung der angegebenen Warteschlange . Die Warteschlange muss ein SAS-Token enthalten.

Parameters:

uri - Ein StorageUri -Objekt, das den absoluten URI der Warteschlange darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

CloudQueue

public CloudQueue(final StorageUri uri, final StorageCredentials credentials)

Erstellt eine instance der -Klasse unter Verwendung der angegebenen Warteschlange und der angegebenen Anmeldeinformationen. Wenn das ein SAS-Token enthält, müssen die Anmeldeinformationen sein.

Parameters:

uri - Ein StorageUri -Objekt, das den absoluten URI der Warteschlange darstellt.
credentials - Ein StorageCredentials -Objekt, das zum Authentifizieren des Zugriffs verwendet wird.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

CloudQueue

protected CloudQueue(final String queueName, final CloudQueueClient client)

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

Parameters:

queueName - Der Name der Warteschlange, die den Benennungsregeln für Warteschlangen entsprechen muss. Der Warteschlangenname darf keine Pfadtrennzeichen (/) enthalten. Warteschlangennamen müssen klein geschrieben sein und zwischen 3 und 63 Zeichen lang sein und mit einem Buchstaben oder einer Zahl beginnen. Warteschlangennamen dürfen nur Buchstaben, Zahlen und das Bindestrichzeichen (-) enthalten.
client - Ein CloudQueueClient -Objekt, das den zugeordneten Dienstclient darstellt und den Endpunkt für den Warteschlangendienst angibt.

Throws:

URISyntaxException - Wenn der Ressourcen-URI, der basierend auf queueName erstellt wurde, ungültig ist.
StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

CloudQueue

public CloudQueue(final URI uri)

Erstellt eine instance der -Klasse unter Verwendung des angegebenen Warteschlangen-URI. Die Warteschlange muss ein SAS-Token enthalten.

Parameters:

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

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

CloudQueue

public CloudQueue(final URI uri, final StorageCredentials credentials)

Erstellt eine instance der -Klasse unter Verwendung der angegebenen Warteschlange und der angegebenen Anmeldeinformationen. Wenn das ein SAS-Token enthält, müssen die Anmeldeinformationen sein.

Parameters:

uri - Ein java.net.URI -Objekt, das den absoluten URI der Warteschlange darstellt.
credentials - Ein StorageCredentials -Objekt, das zum Authentifizieren des Zugriffs verwendet wird.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

Details zur Methode

addMessage

public void addMessage(final CloudQueueMessage message)

Fügt eine Nachricht auf der Rückseite der Warteschlange hinzu.

Parameters:

message - Ein CloudQueueMessage -Objekt, das die hinzuzufügende Nachricht angibt. Das Nachrichtenobjekt wird so geändert, dass es die Nachrichten-ID und den Pop-Beleg enthält, und kann in nachfolgenden Aufrufen von updateMessage und deleteMessage verwendet werden.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

addMessage

public void addMessage(final CloudQueueMessage message, final int timeToLiveInSeconds, final int initialVisibilityDelayInSeconds, QueueRequestOptions options, OperationContext opContext)

Fügt eine Nachricht auf der Rückseite der Warteschlange mit den angegebenen Optionen hinzu.

Parameters:

message - Ein CloudQueueMessage -Objekt, das die hinzuzufügende Nachricht angibt. Das Nachrichtenobjekt wird so geändert, dass es die Nachrichten-ID und den Pop-Beleg enthält, und kann in nachfolgenden Aufrufen von updateMessage und deleteMessage verwendet werden.
timeToLiveInSeconds - Die maximale Zeit, die die Nachricht in der Warteschlange verbleiben kann. Der Wert 0 (null) legt die Gültigkeitsdauer auf den Standardwert des Diensts von sieben Tagen fest. Ein negativer Wert legt eine unendliche Gültigkeitsdauer fest.
initialVisibilityDelayInSeconds - Die Dauer, in der die Nachricht unsichtbar ist, beginnend beim Hinzufügen zur Warteschlange, oder 0, um die Nachricht sofort sichtbar zu machen. Dieser Wert muss größer oder gleich 0 und kleiner als der Wert für die Gültigkeitsdauer sein.
options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

clear

public void clear()

Löscht alle Nachrichten aus der Warteschlange.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

clear

public void clear(QueueRequestOptions options, OperationContext opContext)

Löscht alle Nachrichten aus der Warteschlange unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.

Parameters:

options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

create

public void create()

Erstellt die Warteschlange.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

create

public void create(QueueRequestOptions options, OperationContext opContext)

Erstellt die Warteschlange unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.

Parameters:

options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

createIfNotExists

public boolean createIfNotExists()

Erstellt die Warteschlange, falls sie noch nicht vorhanden ist.

Returns:

Der Wert, true wenn die Warteschlange im Speicherdienst erstellt wird, andernfalls false

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

createIfNotExists

public boolean createIfNotExists(QueueRequestOptions options, OperationContext opContext)

Erstellt die Warteschlange, wenn sie noch nicht vorhanden ist, unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.

Parameters:

options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 Wert von true , wenn die Warteschlange im Speicherdienst erstellt wird, andernfalls false

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

delete

public void delete()

Löscht die Warteschlange.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

delete

public void delete(QueueRequestOptions options, OperationContext opContext)

Löscht die Warteschlange unter Verwendung der angegebenen Anforderungsoptionen und des Vorgangskontexts.

Parameters:

options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

deleteIfExists

public boolean deleteIfExists()

Löscht die Warteschlange, falls vorhanden.

Returns:

Ein Wert von true , wenn die Warteschlange im Speicherdienst vorhanden und gelöscht wurde, andernfalls false.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

deleteIfExists

public boolean deleteIfExists(QueueRequestOptions options, OperationContext opContext)

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

Parameters:

options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 Wert von true , wenn die Warteschlange im Speicherdienst vorhanden und gelöscht wurde, andernfalls false.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

deleteMessage

public void deleteMessage(final CloudQueueMessage message)

Löscht die angegebene Nachricht aus der Warteschlange.

Parameters:

message - Ein CloudQueueMessage -Objekt, das die zu löschende Nachricht angibt.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

deleteMessage

public void deleteMessage(final CloudQueueMessage message, QueueRequestOptions options, OperationContext opContext)

Löscht die angegebene Nachricht unter Verwendung der angegebenen Anforderungsoptionen und des Vorgangskontexts aus der Warteschlange.

Parameters:

message - Ein CloudQueueMessage -Objekt, das die zu löschende Nachricht angibt.
options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

downloadAttributes

public void downloadAttributes()

Lädt die Metadaten und den ungefähren Wert der Nachrichtenanzahl der Warteschlange herunter.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

downloadAttributes

public void downloadAttributes(QueueRequestOptions options, OperationContext opContext)

Lädt die Metadaten und den ungefähren Wert der Nachrichtenanzahl der Warteschlange mithilfe der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts herunter.

Parameters:

options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueue) 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 während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

downloadPermissions

public QueuePermissions downloadPermissions()

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

Returns:

Ein QueuePermissions -Objekt, das die Berechtigungen der Warteschlange darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

downloadPermissions

public QueuePermissions downloadPermissions(QueueRequestOptions options, OperationContext opContext)

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

Parameters:

options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 QueuePermissions -Objekt, das die Berechtigungen des Containers darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

exists

public boolean exists()

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

Returns:

true , wenn die Warteschlange im Speicherdienst vorhanden ist, andernfalls false.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

exists

public boolean exists(QueueRequestOptions options, OperationContext opContext)

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

Parameters:

options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 Warteschlange im Speicherdienst vorhanden ist, andernfalls false.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

generateSharedAccessSignature

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

Gibt eine SAS (Shared Access Signature, Signatur für den gemeinsamen Zugriff) für die Warteschlange zurück.

Parameters:

policy - Die Zugriffsrichtlinie für die SAS (Shared Access Signature).
groupPolicyIdentifier - Eine Zugriffsrichtlinie auf Warteschlangenebene.

Returns:

Eine freigegebene Zugriffssignatur für die Warteschlange.

Throws:

InvalidKeyException - Wenn ein ungültiger Schlüssel übergeben wurde.
StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.
IllegalArgumentException - Wenn ein unerwarteter Wert übergeben wird.

generateSharedAccessSignature

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

Gibt eine SAS (Shared Access Signature, Signatur für den gemeinsamen Zugriff) für die Warteschlange zurück.

Parameters:

policy - Die Zugriffsrichtlinie für die SAS (Shared Access Signature).
groupPolicyIdentifier - Eine Zugriffsrichtlinie auf Warteschlangenebene.
ipRange - Ein IPRange Objekt, das den Bereich der zulässigen IP-Adressen enthält.
protocols - Ein SharedAccessProtocols , der die zulässigen Internetprotokolle darstellt.

Returns:

Eine freigegebene Zugriffssignatur für die Warteschlange.

Throws:

InvalidKeyException - Wenn ein ungültiger Schlüssel übergeben wurde.
StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.
IllegalArgumentException - Wenn ein unerwarteter Wert übergeben wird.

getApproximateMessageCount

public long getApproximateMessageCount()

Ruft die ungefähre Anzahl der Nachrichten der Warteschlange ab. Dieser Wert wird durch eine Anforderung an downloadAttributes() initialisiert und stellt die ungefähre Nachrichtenanzahl dar, wenn diese Anforderung abgeschlossen wurde.

Returns:

Ein Long -Objekt, das die ungefähre Anzahl der Nachrichten der Warteschlange darstellt.

getMetadata

public HashMap getMetadata()

Ruft die Metadatenauflistung für die Warteschlange ab, die in diesem Objekt gespeichert ist. Dieser Wert wird mit den Metadaten aus der Warteschlange durch einen Aufruf downloadAttributes()von initialisiert und für die Warteschlange mit einem Aufruf von uploadMetadata()festgelegt.

Returns:

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

getName

public String getName()

Ruft den Namen der Warteschlange ab.

Returns:

Ein String -Objekt, das den Namen der Warteschlange darstellt.

getServiceClient

public CloudQueueClient getServiceClient()

Ruft den dieser Warteschlange zugeordneten Warteschlangendienstclient ab.

Returns:

Ein CloudQueueClient -Objekt, das den Dienstclient darstellt, der dieser Warteschlange zugeordnet ist.

getShouldEncodeMessage

public boolean getShouldEncodeMessage()

Ruft den Wert ab, der angibt, ob die Nachricht base64-codiert sein soll.

Returns:

Eine Boolean , die angibt, ob die Nachricht base64-codiert sein soll.

getStorageUri

public final StorageUri getStorageUri()

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

Returns:

Eine StorageUri , die die Liste der URIs für alle Standorte darstellt.

getUri

public URI getUri()

Ruft den absoluten URI für diese Warteschlange ab.

Returns:

Ein java.net.URI -Objekt, das den URI für diese Warteschlange darstellt.

peekMessage

public CloudQueueMessage peekMessage()

Es wird eine Nachricht aus der Warteschlange angezeigt. Eine Vorschauanforderung ruft eine Nachricht von der Vorderseite der Warteschlange ab, ohne die Sichtbarkeit zu ändern.

Returns:

Ein CloudQueueMessage -Objekt, das eine Nachricht in dieser Warteschlange darstellt.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

peekMessage

public CloudQueueMessage peekMessage(final QueueRequestOptions options, final OperationContext opContext)

Mit den angegebenen Anforderungsoptionen und dem Vorgangskontext wird eine Nachricht aus der Warteschlange angezeigt. Eine Vorschauanforderung ruft eine Nachricht von der Vorderseite der Warteschlange ab, ohne die Sichtbarkeit zu ändern.

Parameters:

options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 CloudQueueMessage -Objekt, das die angeforderte Nachricht aus der Warteschlange darstellt.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

peekMessages

public Iterable peekMessages(final int numberOfMessages)

Zeigt eine angegebene Anzahl von Nachrichten aus der Warteschlange an. Eine Vorschauanforderung ruft Nachrichten von der Front der Warteschlange ab, ohne ihre Sichtbarkeit zu ändern.

Parameters:

numberOfMessages - Die Anzahl der abzurufenden Nachrichten.

Returns:

Eine aufzählbare Auflistung von CloudQueueMessage Objekten, die die angeforderten Nachrichten aus der Warteschlange darstellt.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

peekMessages

public Iterable peekMessages(final int numberOfMessages, QueueRequestOptions options, OperationContext opContext)

Mit den angegebenen Anforderungsoptionen und dem Vorgangskontext wird ein Satz von Nachrichten aus der Warteschlange angezeigt. Eine Vorschauanforderung ruft Nachrichten von der Front der Warteschlange ab, ohne ihre Sichtbarkeit zu ändern.

Parameters:

numberOfMessages - Die Anzahl der abzurufenden Nachrichten.
options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 CloudQueueMessage Objekten, die die angeforderten Nachrichten aus der Warteschlange darstellt.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

retrieveMessage

public CloudQueueMessage retrieveMessage()

Ruft eine Nachricht von der Vorderseite der Warteschlange mithilfe der Standardanforderungsoptionen ab. Mit diesem Vorgang wird die abgerufene Nachricht in der Warteschlange für den standardmäßigen Timeoutzeitraum der Sichtbarkeit als unsichtbar markiert.

Returns:

Ein CloudQueueMessage -Objekt, das eine Nachricht in dieser Warteschlange darstellt.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

retrieveMessage

public CloudQueueMessage retrieveMessage(final int visibilityTimeoutInSeconds, final QueueRequestOptions options, final OperationContext opContext)

Ruft eine Nachricht von der Vorderseite der Warteschlange ab, wobei die angegebenen Anforderungsoptionen und der angegebene Vorgangskontext verwendet werden. Dieser Vorgang markiert die abgerufene Nachricht als unsichtbar in der Warteschlange für den angegebenen Timeoutzeitraum der Sichtbarkeit.

Parameters:

visibilityTimeoutInSeconds - Gibt das Sichtbarkeitstimeout für die Nachricht in Sekunden an.
options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 CloudQueueMessage -Objekt, das eine Nachricht in dieser Warteschlange darstellt.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

retrieveMessages

public Iterable retrieveMessages(final int numberOfMessages)

Ruft die angegebene Anzahl von Nachrichten von der Front der Warteschlange mithilfe der Standardanforderungsoptionen ab. Mit diesem Vorgang werden die abgerufenen Nachrichten in der Warteschlange für den standardmäßigen Timeoutzeitraum der Sichtbarkeit als unsichtbar markiert.

Parameters:

numberOfMessages - Die Anzahl der abzurufenden Nachrichten.

Returns:

Eine aufzählbare Auflistung von CloudQueueMessage Objekten, die die abgerufenen Nachrichten aus der Warteschlange darstellt.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

retrieveMessages

public Iterable retrieveMessages(final int numberOfMessages, final int visibilityTimeoutInSeconds, QueueRequestOptions options, OperationContext opContext)

Ruft die angegebene Anzahl von Nachrichten von der Front der Warteschlange unter Verwendung der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts ab. Mit diesem Vorgang werden die abgerufenen Nachrichten in der Warteschlange für den standardmäßigen Timeoutzeitraum der Sichtbarkeit als unsichtbar markiert.

Parameters:

numberOfMessages - Die Anzahl der abzurufenden Nachrichten.
visibilityTimeoutInSeconds - Gibt das Sichtbarkeitstimeout für die abgerufenen Nachrichten in Sekunden an.
options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 CloudQueueMessage Objekten, die die aus der Warteschlange abgerufenen Nachrichten darstellt.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

setMetadata

public void setMetadata(final HashMap metadata)

Legt die Metadatenauflistung von Name-Wert-Paaren fest, die in der Warteschlange mit einem uploadMetadata() Aufruf festgelegt werden sollen. Diese Sammlung überschreibt alle vorhandenen Warteschlangenmetadaten. Wenn dies auf eine leere Auflistung festgelegt ist, werden die Warteschlangenmetadaten bei einem uploadMetadata() Aufruf gelöscht.

Parameters:

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

setShouldEncodeMessage

public void setShouldEncodeMessage(final boolean shouldEncodeMessage)

Legt das Flag fest, das angibt, ob die Nachricht base64-codiert sein soll.

Parameters:

shouldEncodeMessage - Der Wert gibt an, ob die Nachricht base64-codiert sein soll.

updateMessage

public void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds)

Updates die angegebene Nachricht in der Warteschlange mit einem neuen Timeoutwert für die Sichtbarkeit in Sekunden.

Parameters:

message - Die CloudQueueMessage zu aktualisierende in der Warteschlange.
visibilityTimeoutInSeconds - Gibt das neue Sichtbarkeitstimeout für die Nachricht in Sekunden an.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

updateMessage

public void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds, final EnumSet messageUpdateFields, QueueRequestOptions options, OperationContext opContext)

Updates eine Nachricht in der Warteschlange mithilfe der angegebenen Anforderungsoptionen und des angegebenen Vorgangskontexts.

Parameters:

message - Die CloudQueueMessage zu aktualisierende in der Warteschlange.
visibilityTimeoutInSeconds - Gibt das neue Sichtbarkeitstimeout für die Nachricht in Sekunden an.
messageUpdateFields - Eine EnumSet von MessageUpdateFields -Werten, die angibt, welche Teile der Nachricht aktualisiert werden sollen.
options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

uploadMetadata

public void uploadMetadata()

Lädt die Metadaten im Objekt in die Warteschlange hoch.

Throws:

StorageException - Wenn während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

uploadMetadata

public void uploadMetadata(QueueRequestOptions options, OperationContext opContext)

Lädt die Metadaten im Objekt mithilfe der angegebenen Anforderungsoptionen und des Vorgangskontexts in die Warteschlange hoch.

Parameters:

options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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 während des Vorgangs ein Speicherdienstfehler aufgetreten ist.

uploadPermissions

public void uploadPermissions(final QueuePermissions permissions)

Lädt die Berechtigungen der Warteschlange hoch.

Parameters:

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

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

uploadPermissions

public void uploadPermissions(final QueuePermissions permissions, QueueRequestOptions options, OperationContext opContext)

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

Parameters:

permissions - Ein QueuePermissions -Objekt, das die Berechtigungen zum Hochladen darstellt.
options - Ein QueueRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudQueueClient) 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.

Gilt für: