Package com.azure.core.util.polling

Class PollOperationDetails

java.lang.Object
com.azure.core.util.polling.PollOperationDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<PollOperationDetails>
public final class PollOperationDetails extends Object implements com.azure.json.JsonSerializable<PollOperationDetails>
PollOperationDetails provides details for long running operations.

  • Method Details

    • getOperationId

      public String getOperationId()
      Gets the unique ID of the operation.
      Returns:
      the unique ID of the operation.

    • getError

      public ResponseError getError()
      Gets the error object that describes the error when status is "Failed".
      Returns:
      the error object that describes the error when status is "Failed".

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Description copied from interface: com.azure.json.JsonSerializable
      Writes the object to the passed JsonWriter.

      The contract for writing JSON to JsonWriter is that the object being written will handle opening and closing its own JSON object. So, for objects calling out to other JsonSerializable objects for serialization, they'll write the field name only then pass the JsonWriter to the other JsonSerializable object. This way objects writing JSON will be self-encapsulated for writing properly formatted JSON.

      Specified by:
      toJson in interface com.azure.json.JsonSerializable<PollOperationDetails>
      Parameters:
      jsonWriter - Where the object's JSON will be written.
      Returns:
      The JsonWriter where the JSON was written.
      Throws:
      IOException - If the object fails to be written to the jsonWriter.

    • fromJson

      public static PollOperationDetails fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads a JSON stream into a PollOperationDetails.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      The PollOperationDetails that the JSON stream represented, or null if it pointed to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If a PollOperationDetails fails to be read from the jsonReader.