2021-11-06 07:31:45 +03:00
### YamlMime:JavaType
uid : "com.azure.core.util.polling.StatusCheckPollingStrategy"
fullName : "com.azure.core.util.polling.StatusCheckPollingStrategy<T,U>"
name : "StatusCheckPollingStrategy<T,U>"
nameWithType : "StatusCheckPollingStrategy<T,U>"
summary : "Fallback polling strategy that doesn't poll but exits successfully if no other polling strategies are detected and status code is 2xx."
inheritances :
2022-08-11 07:43:16 +03:00
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
2022-09-27 07:22:51 +03:00
inheritedClassMethods :
- classRef : "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef :
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
2022-11-01 07:30:49 +03:00
syntax : "public class **StatusCheckPollingStrategy<T,U>**</br> implements <xref href=\"com.azure.core.util.polling.PollingStrategy?alt=com.azure.core.util.polling.PollingStrategy&text=PollingStrategy\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />,<xref href=\"U?alt=U&text=U\" data-throw-if-not-resolved=\"False\" />>"
2021-11-06 07:31:45 +03:00
constructors :
2022-08-22 08:55:24 +03:00
- uid : "com.azure.core.util.polling.StatusCheckPollingStrategy.StatusCheckPollingStrategy()"
fullName : "com.azure.core.util.polling.StatusCheckPollingStrategy<T,U>.StatusCheckPollingStrategy()"
name : "StatusCheckPollingStrategy()"
nameWithType : "StatusCheckPollingStrategy<T,U>.StatusCheckPollingStrategy()"
summary : "Creates a status check polling strategy with a JSON serializer."
syntax : "public StatusCheckPollingStrategy()"
desc : "Creates a status check polling strategy with a JSON serializer."
- uid : "com.azure.core.util.polling.StatusCheckPollingStrategy.StatusCheckPollingStrategy(com.azure.core.util.serializer.ObjectSerializer)"
fullName : "com.azure.core.util.polling.StatusCheckPollingStrategy<T,U>.StatusCheckPollingStrategy(ObjectSerializer serializer)"
name : "StatusCheckPollingStrategy(ObjectSerializer serializer)"
nameWithType : "StatusCheckPollingStrategy<T,U>.StatusCheckPollingStrategy(ObjectSerializer serializer)"
summary : "Creates a status check polling strategy with a custom object serializer."
parameters :
- description : "a custom serializer for serializing and deserializing polling responses"
name : "serializer"
type : "<xref href=\"com.azure.core.util.serializer.ObjectSerializer?alt=com.azure.core.util.serializer.ObjectSerializer&text=ObjectSerializer\" data-throw-if-not-resolved=\"False\" />"
syntax : "public StatusCheckPollingStrategy(ObjectSerializer serializer)"
desc : "Creates a status check polling strategy with a custom object serializer."
2021-11-06 07:31:45 +03:00
methods :
2022-08-22 08:55:24 +03:00
- uid : "com.azure.core.util.polling.StatusCheckPollingStrategy.canPoll(com.azure.core.http.rest.Response<?>)"
fullName : "com.azure.core.util.polling.StatusCheckPollingStrategy<T,U>.canPoll(Response<?> initialResponse)"
name : "canPoll(Response<?> initialResponse)"
nameWithType : "StatusCheckPollingStrategy<T,U>.canPoll(Response<?> initialResponse)"
summary : "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response."
parameters :
- name : "initialResponse"
type : "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><?>"
syntax : "public Mono<Boolean> canPoll(Response<?> initialResponse)"
desc : "Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response."
returns :
2024-08-08 08:04:37 +03:00
type : "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>>"
2022-08-22 08:55:24 +03:00
- uid : "com.azure.core.util.polling.StatusCheckPollingStrategy.getResult(com.azure.core.util.polling.PollingContext<T>,com.azure.core.util.serializer.TypeReference<U>)"
fullName : "com.azure.core.util.polling.StatusCheckPollingStrategy<T,U>.getResult(PollingContext<T> pollingContext, TypeReference<U> resultType)"
name : "getResult(PollingContext<T> pollingContext, TypeReference<U> resultType)"
nameWithType : "StatusCheckPollingStrategy<T,U>.getResult(PollingContext<T> pollingContext, TypeReference<U> resultType)"
summary : "Parses the response from the final GET call into the result type of the long-running operation."
parameters :
- name : "pollingContext"
type : "<xref href=\"com.azure.core.util.polling.PollingContext?alt=com.azure.core.util.polling.PollingContext&text=PollingContext\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- name : "resultType"
type : "<xref href=\"com.azure.core.util.serializer.TypeReference?alt=com.azure.core.util.serializer.TypeReference&text=TypeReference\" data-throw-if-not-resolved=\"False\" /><<xref href=\"U?alt=U&text=U\" data-throw-if-not-resolved=\"False\" />>"
syntax : "public Mono<U> getResult(PollingContext<T> pollingContext, TypeReference<U> resultType)"
desc : "Parses the response from the final GET call into the result type of the long-running operation."
returns :
2024-08-08 08:04:37 +03:00
type : "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"U?alt=U&text=U\" data-throw-if-not-resolved=\"False\" />>"
2022-08-22 08:55:24 +03:00
- uid : "com.azure.core.util.polling.StatusCheckPollingStrategy.onInitialResponse(com.azure.core.http.rest.Response<?>,com.azure.core.util.polling.PollingContext<T>,com.azure.core.util.serializer.TypeReference<T>)"
fullName : "com.azure.core.util.polling.StatusCheckPollingStrategy<T,U>.onInitialResponse(Response<?> response, PollingContext<T> pollingContext, TypeReference<T> pollResponseType)"
name : "onInitialResponse(Response<?> response, PollingContext<T> pollingContext, TypeReference<T> pollResponseType)"
nameWithType : "StatusCheckPollingStrategy<T,U>.onInitialResponse(Response<?> response, PollingContext<T> pollingContext, TypeReference<T> pollResponseType)"
summary : "Parses the initial response into a <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref>, and stores information useful for polling in the <xref uid=\"com.azure.core.util.polling.PollingContext\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollingContext\"></xref>."
parameters :
- name : "response"
type : "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><?>"
- name : "pollingContext"
type : "<xref href=\"com.azure.core.util.polling.PollingContext?alt=com.azure.core.util.polling.PollingContext&text=PollingContext\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- name : "pollResponseType"
type : "<xref href=\"com.azure.core.util.serializer.TypeReference?alt=com.azure.core.util.serializer.TypeReference&text=TypeReference\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
syntax : "public Mono<PollResponse<T>> onInitialResponse(Response<?> response, PollingContext<T> pollingContext, TypeReference<T> pollResponseType)"
desc : "Parses the initial response into a <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref>, and stores information useful for polling in the <xref uid=\"com.azure.core.util.polling.PollingContext\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollingContext\"></xref>. If the result is anything other than <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus.IN_PROGRESS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus#IN_PROGRESS\"></xref>, the long-running operation will be terminated and none of the other methods will be invoked."
returns :
2024-08-08 08:04:37 +03:00
type : "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.util.polling.PollResponse?alt=com.azure.core.util.polling.PollResponse&text=PollResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>>"
2022-08-22 08:55:24 +03:00
- uid : "com.azure.core.util.polling.StatusCheckPollingStrategy.poll(com.azure.core.util.polling.PollingContext<T>,com.azure.core.util.serializer.TypeReference<T>)"
fullName : "com.azure.core.util.polling.StatusCheckPollingStrategy<T,U>.poll(PollingContext<T> context, TypeReference<T> pollResponseType)"
name : "poll(PollingContext<T> context, TypeReference<T> pollResponseType)"
nameWithType : "StatusCheckPollingStrategy<T,U>.poll(PollingContext<T> context, TypeReference<T> pollResponseType)"
summary : "Parses the response from the polling URL into a <xref uid=\"com.azure.core.util.polling.PollResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollResponse\"></xref>, and stores information useful for further polling and final response in the <xref uid=\"com.azure.core.util.polling.PollingContext\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollingContext\"></xref>."
parameters :
- name : "context"
type : "<xref href=\"com.azure.core.util.polling.PollingContext?alt=com.azure.core.util.polling.PollingContext&text=PollingContext\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
- name : "pollResponseType"
type : "<xref href=\"com.azure.core.util.serializer.TypeReference?alt=com.azure.core.util.serializer.TypeReference&text=TypeReference\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
syntax : "public Mono<PollResponse<T>> poll(PollingContext<T> context, TypeReference<T> pollResponseType)"
desc : "Parses the response from the polling URL into a <xref uid=\"com.azure.core.util.polling.PollResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollResponse\"></xref>, and stores information useful for further polling and final response in the <xref uid=\"com.azure.core.util.polling.PollingContext\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollingContext\"></xref>. The result must have the <xref uid=\"com.azure.core.util.polling.LongRunningOperationStatus\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LongRunningOperationStatus\"></xref> specified, and the entire polling response content as a <xref uid=\"com.azure.core.util.BinaryData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BinaryData\"></xref>."
returns :
2024-08-08 08:04:37 +03:00
type : "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.util.polling.PollResponse?alt=com.azure.core.util.polling.PollResponse&text=PollResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>>"
2021-11-06 07:31:45 +03:00
type : "class"
typeParameters :
2022-08-11 07:43:16 +03:00
- description : "the type of the response type from a polling call, or BinaryData if raw response body should be kept"
name : "T"
2024-03-12 07:45:40 +03:00
- description : "the type of the final result object to deserialize into, or BinaryData if raw response body should be\n kept"
2022-08-11 07:43:16 +03:00
name : "U"
desc : "Fallback polling strategy that doesn't poll but exits successfully if no other polling strategies are detected and status code is 2xx."
2021-11-06 07:31:45 +03:00
implements :
- "<xref href=\"com.azure.core.util.polling.PollingStrategy?alt=com.azure.core.util.polling.PollingStrategy&text=PollingStrategy\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />,<xref href=\"U?alt=U&text=U\" data-throw-if-not-resolved=\"False\" />>"
metadata : {}
package : "com.azure.core.util.polling"
2024-08-03 07:58:45 +03:00
artifact : com.azure:azure-core:1.51.0