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 Summary

Modifier and Type	Method	Description
static PollOperationDetails	fromJson(com.azure.json.JsonReader jsonReader)	Reads a JSON stream into a PollOperationDetails.
ResponseError	getError()	Gets the error object that describes the error when status is "Failed".
String	getOperationId()	Gets the unique ID of the operation.
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

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

Specified by:

toJson in interface com.azure.json.JsonSerializable<PollOperationDetails>

Throws:

IOException

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.