LongRunningOperation Class

Provides default logic for interpreting operation responses and status updates.

Inheritance

ABC

LongRunningOperation

Constructor

LongRunningOperation()

Parameters

response

PipelineResponse

Required

The initial pipeline response.

deserialization_callback

callable

Required

The deserialization callaback.

lro_options

dict

Required

LRO options.

kwargs

Required

Unused for now

Methods

can_poll	Answer if this polling method could be used.
get_final_get_url	If a final GET is needed, returns the URL.
get_polling_url	Return the polling URL.
get_status	Return the status string extracted from this response.
set_initial_status	Process first response after initiating long running operation.

can_poll

Answer if this polling method could be used.

abstract can_poll(pipeline_response: PipelineResponseType) -> bool

Parameters

pipeline_response

Required

get_final_get_url

If a final GET is needed, returns the URL.

abstract get_final_get_url(pipeline_response: PipelineResponseType) -> Optional[str]

Parameters

pipeline_response

Required

Return type

str

get_polling_url

Return the polling URL.

abstract get_polling_url() -> str

get_status

Return the status string extracted from this response.

abstract get_status(pipeline_response: PipelineResponseType) -> str

Parameters

pipeline_response

Required

set_initial_status

Process first response after initiating long running operation.

abstract set_initial_status(pipeline_response: PipelineResponseType) -> str

Parameters

response

PipelineResponse

Required

initial REST call response.