Class AzureFunctionStorageQueue

java.lang.Object
com.azure.ai.agents.persistent.models.AzureFunctionStorageQueue
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureFunctionStorageQueue>

public final class AzureFunctionStorageQueue extends Object implements com.azure.json.JsonSerializable<AzureFunctionStorageQueue>
The structure for keeping storage queue name and URI.
  • Constructor Summary

    Constructors
    Constructor
    Description
    AzureFunctionStorageQueue(String storageServiceEndpoint, String queueName)
    Creates an instance of AzureFunctionStorageQueue class.
  • Method Summary

    Modifier and Type
    Method
    Description
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of AzureFunctionStorageQueue from the JsonReader.
    Get the queueName property: The name of an Azure function storage queue.
    Get the storageServiceEndpoint property: URI to the Azure Storage Queue service allowing you to manipulate a queue.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString
  • Constructor Details

    • AzureFunctionStorageQueue

      public AzureFunctionStorageQueue(String storageServiceEndpoint, String queueName)
      Creates an instance of AzureFunctionStorageQueue class.
      Parameters:
      storageServiceEndpoint - the storageServiceEndpoint value to set.
      queueName - the queueName value to set.
  • Method Details

    • getStorageServiceEndpoint

      public String getStorageServiceEndpoint()
      Get the storageServiceEndpoint property: URI to the Azure Storage Queue service allowing you to manipulate a queue.
      Returns:
      the storageServiceEndpoint value.
    • getQueueName

      public String getQueueName()
      Get the queueName property: The name of an Azure function storage queue.
      Returns:
      the queueName value.
    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AzureFunctionStorageQueue>
      Throws:
      IOException
    • fromJson

      public static AzureFunctionStorageQueue fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AzureFunctionStorageQueue from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AzureFunctionStorageQueue if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AzureFunctionStorageQueue.