167 строки
18 KiB
YAML
167 строки
18 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.util.polling.LocationPollingStrategy"
|
|
fullName: "com.azure.core.util.polling.LocationPollingStrategy<T,U>"
|
|
name: "LocationPollingStrategy<T,U>"
|
|
nameWithType: "LocationPollingStrategy<T,U>"
|
|
summary: "Implements a Location polling strategy."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
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>"
|
|
syntax: "public class **LocationPollingStrategy<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\" />>"
|
|
constructors:
|
|
- uid: "com.azure.core.util.polling.LocationPollingStrategy.LocationPollingStrategy(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.core.util.polling.LocationPollingStrategy<T,U>.LocationPollingStrategy(HttpPipeline httpPipeline)"
|
|
name: "LocationPollingStrategy(HttpPipeline httpPipeline)"
|
|
nameWithType: "LocationPollingStrategy<T,U>.LocationPollingStrategy(HttpPipeline httpPipeline)"
|
|
summary: "Creates an instance of the location polling strategy using a JSON serializer."
|
|
parameters:
|
|
- description: "an instance of <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to send requests with"
|
|
name: "httpPipeline"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public LocationPollingStrategy(HttpPipeline httpPipeline)"
|
|
desc: "Creates an instance of the location polling strategy using a JSON serializer."
|
|
- uid: "com.azure.core.util.polling.LocationPollingStrategy.LocationPollingStrategy(com.azure.core.http.HttpPipeline,com.azure.core.util.serializer.ObjectSerializer)"
|
|
fullName: "com.azure.core.util.polling.LocationPollingStrategy<T,U>.LocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer)"
|
|
name: "LocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer)"
|
|
nameWithType: "LocationPollingStrategy<T,U>.LocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer)"
|
|
summary: "Creates an instance of the location polling strategy."
|
|
parameters:
|
|
- description: "an instance of <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to send requests with"
|
|
name: "httpPipeline"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 LocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer)"
|
|
desc: "Creates an instance of the location polling strategy."
|
|
- uid: "com.azure.core.util.polling.LocationPollingStrategy.LocationPollingStrategy(com.azure.core.http.HttpPipeline,com.azure.core.util.serializer.ObjectSerializer,com.azure.core.util.Context)"
|
|
fullName: "com.azure.core.util.polling.LocationPollingStrategy<T,U>.LocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, Context context)"
|
|
name: "LocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, Context context)"
|
|
nameWithType: "LocationPollingStrategy<T,U>.LocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, Context context)"
|
|
summary: "Creates an instance of the location polling strategy."
|
|
parameters:
|
|
- description: "an instance of <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to send requests with"
|
|
name: "httpPipeline"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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\" />"
|
|
- description: "an instance of <xref uid=\"com.azure.core.util.Context\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Context\"></xref>"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public LocationPollingStrategy(HttpPipeline httpPipeline, ObjectSerializer serializer, Context context)"
|
|
desc: "Creates an instance of the location polling strategy."
|
|
- uid: "com.azure.core.util.polling.LocationPollingStrategy.LocationPollingStrategy(com.azure.core.http.HttpPipeline,java.lang.String,com.azure.core.util.serializer.ObjectSerializer,com.azure.core.util.Context)"
|
|
fullName: "com.azure.core.util.polling.LocationPollingStrategy<T,U>.LocationPollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, Context context)"
|
|
name: "LocationPollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, Context context)"
|
|
nameWithType: "LocationPollingStrategy<T,U>.LocationPollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, Context context)"
|
|
summary: "Creates an instance of the location polling strategy."
|
|
parameters:
|
|
- description: "an instance of <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to send requests with"
|
|
name: "httpPipeline"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "an endpoint for creating an absolute path when the path itself is relative."
|
|
name: "endpoint"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- 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\" />"
|
|
- description: "an instance of <xref uid=\"com.azure.core.util.Context\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Context\"></xref>"
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public LocationPollingStrategy(HttpPipeline httpPipeline, String endpoint, ObjectSerializer serializer, Context context)"
|
|
desc: "Creates an instance of the location polling strategy."
|
|
- uid: "com.azure.core.util.polling.LocationPollingStrategy.LocationPollingStrategy(com.azure.core.util.polling.PollingStrategyOptions)"
|
|
fullName: "com.azure.core.util.polling.LocationPollingStrategy<T,U>.LocationPollingStrategy(PollingStrategyOptions pollingStrategyOptions)"
|
|
name: "LocationPollingStrategy(PollingStrategyOptions pollingStrategyOptions)"
|
|
nameWithType: "LocationPollingStrategy<T,U>.LocationPollingStrategy(PollingStrategyOptions pollingStrategyOptions)"
|
|
summary: "Creates an instance of the location polling strategy."
|
|
parameters:
|
|
- description: "options to configure this polling strategy."
|
|
name: "pollingStrategyOptions"
|
|
type: "<xref href=\"com.azure.core.util.polling.PollingStrategyOptions?alt=com.azure.core.util.polling.PollingStrategyOptions&text=PollingStrategyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public LocationPollingStrategy(PollingStrategyOptions pollingStrategyOptions)"
|
|
desc: "Creates an instance of the location polling strategy."
|
|
methods:
|
|
- uid: "com.azure.core.util.polling.LocationPollingStrategy.canPoll(com.azure.core.http.rest.Response<?>)"
|
|
fullName: "com.azure.core.util.polling.LocationPollingStrategy<T,U>.canPoll(Response<?> initialResponse)"
|
|
name: "canPoll(Response<?> initialResponse)"
|
|
nameWithType: "LocationPollingStrategy<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:
|
|
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>>"
|
|
- uid: "com.azure.core.util.polling.LocationPollingStrategy.getResult(com.azure.core.util.polling.PollingContext<T>,com.azure.core.util.serializer.TypeReference<U>)"
|
|
fullName: "com.azure.core.util.polling.LocationPollingStrategy<T,U>.getResult(PollingContext<T> pollingContext, TypeReference<U> resultType)"
|
|
name: "getResult(PollingContext<T> pollingContext, TypeReference<U> resultType)"
|
|
nameWithType: "LocationPollingStrategy<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:
|
|
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\" />>"
|
|
- uid: "com.azure.core.util.polling.LocationPollingStrategy.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.LocationPollingStrategy<T,U>.onInitialResponse(Response<?> response, PollingContext<T> pollingContext, TypeReference<T> pollResponseType)"
|
|
name: "onInitialResponse(Response<?> response, PollingContext<T> pollingContext, TypeReference<T> pollResponseType)"
|
|
nameWithType: "LocationPollingStrategy<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:
|
|
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\" />>>"
|
|
- uid: "com.azure.core.util.polling.LocationPollingStrategy.poll(com.azure.core.util.polling.PollingContext<T>,com.azure.core.util.serializer.TypeReference<T>)"
|
|
fullName: "com.azure.core.util.polling.LocationPollingStrategy<T,U>.poll(PollingContext<T> pollingContext, TypeReference<T> pollResponseType)"
|
|
name: "poll(PollingContext<T> pollingContext, TypeReference<T> pollResponseType)"
|
|
nameWithType: "LocationPollingStrategy<T,U>.poll(PollingContext<T> pollingContext, 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: "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>> poll(PollingContext<T> pollingContext, 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:
|
|
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\" />>>"
|
|
type: "class"
|
|
typeParameters:
|
|
- description: "the type of the response type from a polling call, or BinaryData if raw response body should be kept"
|
|
name: "T"
|
|
- description: "the type of the final result object to deserialize into, or BinaryData if raw response body should be\n kept"
|
|
name: "U"
|
|
desc: "Implements a Location polling strategy."
|
|
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"
|
|
artifact: com.azure:azure-core:1.54.0
|