LocationPolling Class

Implements a Location polling.

Inheritance

LongRunningOperation

LocationPolling

Constructor

LocationPolling()

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	Process the latest status update retrieved from a 'location' header.
set_initial_status	Process first response after initiating long running operation.

can_poll

Answer if this polling method could be used.

can_poll(pipeline_response: PipelineResponseType) -> bool

Parameters

pipeline_response

Required

get_final_get_url

If a final GET is needed, returns the URL.

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

Parameters

pipeline_response

Required

Return type

str

get_polling_url

Return the polling URL.

get_polling_url() -> str

get_status

Process the latest status update retrieved from a 'location' header.

get_status(pipeline_response: PipelineResponseType) -> str

Parameters

response

PipelineResponse

Required

latest REST call response.

Exceptions

BadResponse if response has no body and not status 202.

set_initial_status

Process first response after initiating long running operation.

set_initial_status(pipeline_response: PipelineResponseType) -> str

Parameters

response

PipelineResponse

Required

initial REST call response.