CloudQueueClient Klasse

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

public class CloudQueueClient extends ServiceClient

Stellt einen Dienstclient für den Zugriff auf den Microsoft Azure Queue-Dienst bereit.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
CloudQueueClient(final StorageUri baseUri, final StorageCredentials credentials)

Initialisiert einen neuen instance der -Klasse unter Verwendung des angegebenen Warteschlangendienstendpunkts und der angegebenen Kontoanmeldeinformationen.
CloudQueueClient(final URI baseUri, final StorageCredentials credentials)

Initialisiert einen neuen instance der -Klasse unter Verwendung des angegebenen Warteschlangendienstendpunkts und der angegebenen Kontoanmeldeinformationen.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
final ServiceProperties downloadServiceProperties()

Ruft den aktuellen ServiceProperties für den angegebenen Speicherdienst ab. Dies umfasst Protokollierung, HourMetrics, MinuteMetrics und CORS-Konfigurationen.
final ServiceProperties downloadServiceProperties(QueueRequestOptions options, OperationContext opContext)

Ruft den aktuellen ServiceProperties für den angegebenen Speicherdienst ab. Dies umfasst Protokollierung, HourMetrics, MinuteMetrics und CORS-Konfigurationen.
QueueRequestOptions getDefaultRequestOptions()

Ruft die ab, die für Anforderungen verwendet wird, die QueueRequestOptions diesem zugeordnet sind.
CloudQueue getQueueReference(final String queueName)

Ruft ein CloudQueue -Objekt mit dem angegebenen Namen ab.
ServiceStats getServiceStats()

Fragt den Dienst nach ab ServiceStats.
ServiceStats getServiceStats(QueueRequestOptions options, OperationContext opContext)

Fragt den Dienst nach ab ServiceStats.
boolean isUsePathStyleUris()
Iterable<CloudQueue> listQueues()

Ruft eine iterierbare Auflistung von Warteschlangen für diesen Warteschlangendienstclient ab.
Iterable<CloudQueue> listQueues(final String prefix)

Gibt eine iterierbare Auflistung von Warteschlangen zurück, deren Namen mit dem angegebenen Präfix in diesem Warteschlangendienstclient beginnen.
Iterable<CloudQueue> listQueues(final String prefix, final QueueListingDetails detailsIncluded, QueueRequestOptions options, OperationContext opContext)

Gibt eine iterierbare Auflistung von Warteschlangen zurück, deren Namen mit dem angegebenen Präfix für diesen Warteschlangendienstclient beginnen, wobei die angegebene Detaileinstellung, Anforderungsoptionen und der angegebene Vorgangskontext verwendet werden.
ResultSegment<CloudQueue> listQueuesSegmented()

Ruft ein Ergebnissegment einer iterierbaren Auflistung von Warteschlangen für diesen Warteschlangendienstclient ab.
ResultSegment<CloudQueue> listQueuesSegmented(final String prefix)

Ruft ein Ergebnissegment einer iterierbaren Auflistung von Warteschlangen ab, deren Namen mit dem angegebenen Präfix für diesen Warteschlangendienstclient beginnen.
ResultSegment<CloudQueue> listQueuesSegmented(final String prefix, final QueueListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, QueueRequestOptions options, OperationContext opContext)

Ruft ein Ergebnissegment einer iterierbaren Auflistung von Warteschlangen ab, deren Namen mit dem angegebenen Präfix für diese Warteschlange beginnen, und verwendet dabei die angegebenen Listendetails, Anforderungsoptionen und den angegebenen Vorgangskontext.
void setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions)

Legt die fest, die QueueRequestOptions für jede Warteschlange verwendet wird, auf die mit diesem Objekt zugegriffen wird.
void uploadServiceProperties(final ServiceProperties properties)

Lädt eine neue ServiceProperties Konfiguration in den angegebenen Speicherdienst hoch. Dazu gehören Protokollierung, HourMetrics, MinuteMetrics und CORS-Konfigurationen.
void uploadServiceProperties(final ServiceProperties properties, QueueRequestOptions options, OperationContext opContext)

Lädt eine neue ServiceProperties Konfiguration in den angegebenen Speicherdienst hoch. Dazu gehören Protokollierung, HourMetrics, MinuteMetrics und CORS-Konfigurationen.

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

CloudQueueClient

public CloudQueueClient(final StorageUri baseUri, final StorageCredentials credentials)

Initialisiert einen neuen instance der -Klasse unter Verwendung des angegebenen Warteschlangendienstendpunkts und der angegebenen Kontoanmeldeinformationen.

Parameters:

baseUri - Ein StorageUri -Objekt, das den Warteschlangendienstendpunkt darstellt, der zum Erstellen des Clients verwendet wird.
credentials - Ein StorageCredentials -Objekt, das die Kontoanmeldeinformationen darstellt.

CloudQueueClient

public CloudQueueClient(final URI baseUri, final StorageCredentials credentials)

Initialisiert einen neuen instance der -Klasse unter Verwendung des angegebenen Warteschlangendienstendpunkts und der angegebenen Kontoanmeldeinformationen.

Parameters:

baseUri - Ein java.net.URI -Objekt, das den Warteschlangendienstendpunkt darstellt, der zum Erstellen des Clients verwendet wird.
credentials - Ein StorageCredentials -Objekt, das die Kontoanmeldeinformationen darstellt.

Details zur Methode

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

Ruft den aktuellen ServiceProperties für den angegebenen Speicherdienst ab. Dies umfasst Protokollierung, HourMetrics, MinuteMetrics und CORS-Konfigurationen.

Returns:

das ServiceProperties Objekt, das die aktuelle Konfiguration des Diensts darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(QueueRequestOptions options, OperationContext opContext)

Ruft den aktuellen ServiceProperties für den angegebenen Speicherdienst ab. Dies umfasst Protokollierung, HourMetrics, MinuteMetrics und CORS-Konfigurationen.

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:

das ServiceProperties Objekt, das die aktuelle Konfiguration des Diensts darstellt.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

getDefaultRequestOptions

public QueueRequestOptions getDefaultRequestOptions()

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

Returns:

Das QueueRequestOptions Objekt, das die von diesem verwendeten Werte enthält CloudQueueClient

getQueueReference

public CloudQueue getQueueReference(final String queueName)

Ruft ein CloudQueue -Objekt mit dem angegebenen Namen ab.

Parameters:

queueName - Der Name der Warteschlange, die den Warteschlangenbenennungsregeln entsprechen muss. Der Warteschlangenname darf keine Pfadtrennzeichen (/) enthalten. Warteschlangennamen müssen kleingeschrieben sein, 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.

Returns:

Ein Verweis auf ein CloudQueue-Objekt.

Throws:

URISyntaxException - Wenn der ressourcenbasierte URI, der auf der Grundlage von queueName erstellt wurde, ungültig ist.
StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

getServiceStats

public ServiceStats getServiceStats()

Fragt den Dienst nach ab ServiceStats.

Returns:

ServiceStats für den angegebenen Speicherdienst

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

getServiceStats

public ServiceStats getServiceStats(QueueRequestOptions options, OperationContext opContext)

Fragt den Dienst nach ab ServiceStats.

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:

ServiceStats für den angegebenen Speicherdienst

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

isUsePathStyleUris

protected boolean isUsePathStyleUris()

Returns:

usePathStyleUris

listQueues

public Iterable listQueues()

Ruft eine iterierbare Auflistung von Warteschlangen für diesen Warteschlangendienstclient ab.

Returns:

Eine iterierbare Auflistung von CloudQueue Objekten, die lazily abgerufen werden und die die Warteschlangen in diesem Client darstellen.

listQueues

public Iterable listQueues(final String prefix)

Gibt eine iterierbare Auflistung von Warteschlangen zurück, deren Namen mit dem angegebenen Präfix in diesem Warteschlangendienstclient beginnen.

Parameters:

prefix - Ein String , das das Präfix für den Warteschlangennamen darstellt.

Returns:

Eine iterierbare Auflistung von CloudQueue Objekten, die lazily abgerufen werden und die die Warteschlangen in diesem Client darstellen, deren Namen mit dem angegebenen Präfix beginnen.

listQueues

public Iterable listQueues(final String prefix, final QueueListingDetails detailsIncluded, QueueRequestOptions options, OperationContext opContext)

Gibt eine iterierbare Auflistung von Warteschlangen zurück, deren Namen mit dem angegebenen Präfix für diesen Warteschlangendienstclient beginnen, wobei die angegebene Detaileinstellung, Anforderungsoptionen und der angegebene Vorgangskontext verwendet werden.

Parameters:

prefix - Ein String , das das Präfix für den Warteschlangennamen darstellt.
detailsIncluded - Ein QueueListingDetails Wert, der angibt, ob Warteschlangenmetadaten zurückgegeben werden.
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.

Returns:

Eine iterierbare Auflistung von CloudQueue Objekten, die verzögert abgerufen werden und die die angegebenen Warteschlangen für diesen Client darstellen.

listQueuesSegmented

public ResultSegment listQueuesSegmented()

Ruft ein Ergebnissegment einer iterierbaren Auflistung von Warteschlangen für diesen Warteschlangendienstclient ab.

Returns:

Eine ResultSegment<T> von CloudQueue -Objekten, die ein Segment der iterierbaren Auflistung von CloudQueue Objekten enthält, die die angeforderten Warteschlangen im Speicherdienst darstellen.

Throws:

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

listQueuesSegmented

public ResultSegment listQueuesSegmented(final String prefix)

Ruft ein Ergebnissegment einer iterierbaren Auflistung von Warteschlangen ab, deren Namen mit dem angegebenen Präfix für diesen Warteschlangendienstclient beginnen.

Parameters:

prefix

Returns:

Eine ResultSegment<T> von CloudQueue -Objekten, die ein Segment der iterierbaren Auflistung von CloudQueue Objekten enthält, die die angeforderten Warteschlangen im Speicherdienst darstellen.

Throws:

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

listQueuesSegmented

public ResultSegment listQueuesSegmented(final String prefix, final QueueListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, QueueRequestOptions options, OperationContext opContext)

Ruft ein Ergebnissegment einer iterierbaren Auflistung von Warteschlangen ab, deren Namen mit dem angegebenen Präfix für diese Warteschlange beginnen, und verwendet dabei die angegebenen Listendetails, Anforderungsoptionen und den angegebenen Vorgangskontext.

Parameters:

prefix - Ein String , das das Präfix des abzugleichenden Warteschlangennamens darstellt.
detailsIncluded - Ein QueueListingDetails -Wert, der angibt, ob Warteschlangenmetadaten 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 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.

Returns:

Eine ResultSegment<T> von CloudQueue -Objekten, die ein Segment der iterierbaren Auflistung von CloudQueue Objekten enthält, die die angeforderten Warteschlangen im Speicherdienst darstellen.

Throws:

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

setDefaultRequestOptions

public void setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions)

Legt die fest, die QueueRequestOptions für jede Warteschlange verwendet wird, auf die mit diesem Objekt zugegriffen wird.

Parameters:

defaultRequestOptions - Die zu verwendenden QueueRequestOptions.

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

Lädt eine neue ServiceProperties Konfiguration in den angegebenen Speicherdienst hoch. Dazu gehören Protokollierung, HourMetrics, MinuteMetrics und CORS-Konfigurationen.

Parameters:

properties - Die ServiceProperties hochzuladende.

Throws:

StorageException - Wenn ein Speicherdienstfehler aufgetreten ist.

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties, QueueRequestOptions options, OperationContext opContext)

Lädt eine neue ServiceProperties Konfiguration in den angegebenen Speicherdienst hoch. Dazu gehören Protokollierung, HourMetrics, MinuteMetrics und CORS-Konfigurationen.

Parameters:

properties - Die ServiceProperties hochzuladende.
options - Ein BlobRequestOptions -Objekt, das alle zusätzlichen Optionen für die Anforderung angibt. Wenn Sie angeben, null werden die Standardanforderungsoptionen des zugeordneten Dienstclients ( CloudBlobClient) 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: