148 строки
14 KiB
YAML
148 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.util.polling.PollingStrategyOptions"
|
|
fullName: "com.azure.core.util.polling.PollingStrategyOptions"
|
|
name: "PollingStrategyOptions"
|
|
nameWithType: "PollingStrategyOptions"
|
|
summary: "Options to configure 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 final class **PollingStrategyOptions**"
|
|
constructors:
|
|
- uid: "com.azure.core.util.polling.PollingStrategyOptions.PollingStrategyOptions(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.core.util.polling.PollingStrategyOptions.PollingStrategyOptions(HttpPipeline httpPipeline)"
|
|
name: "PollingStrategyOptions(HttpPipeline httpPipeline)"
|
|
nameWithType: "PollingStrategyOptions.PollingStrategyOptions(HttpPipeline httpPipeline)"
|
|
summary: "The <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for polling and getting the final result of the long-running operation."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for polling and getting the final result of the long-running operation."
|
|
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 PollingStrategyOptions(HttpPipeline httpPipeline)"
|
|
desc: "The <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for polling and getting the final result of the long-running operation."
|
|
methods:
|
|
- uid: "com.azure.core.util.polling.PollingStrategyOptions.getContext()"
|
|
fullName: "com.azure.core.util.polling.PollingStrategyOptions.getContext()"
|
|
name: "getContext()"
|
|
nameWithType: "PollingStrategyOptions.getContext()"
|
|
summary: "Returns the context to use for sending the request using the <xref uid=\"com.azure.core.util.polling.PollingStrategyOptions.getHttpPipeline()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getHttpPipeline()\"></xref>."
|
|
syntax: "public Context getContext()"
|
|
desc: "Returns the context to use for sending the request using the <xref uid=\"com.azure.core.util.polling.PollingStrategyOptions.getHttpPipeline()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getHttpPipeline()\"></xref>."
|
|
returns:
|
|
description: "the context to use for sending the request using the <xref uid=\"com.azure.core.util.polling.PollingStrategyOptions.getHttpPipeline()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getHttpPipeline()\"></xref>."
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.util.polling.PollingStrategyOptions.getEndpoint()"
|
|
fullName: "com.azure.core.util.polling.PollingStrategyOptions.getEndpoint()"
|
|
name: "getEndpoint()"
|
|
nameWithType: "PollingStrategyOptions.getEndpoint()"
|
|
summary: "Returns the endpoint that will be used as prefix if the service response returns a relative path for getting the long-running operation status and final result."
|
|
syntax: "public String getEndpoint()"
|
|
desc: "Returns the endpoint that will be used as prefix if the service response returns a relative path for getting the long-running operation status and final result."
|
|
returns:
|
|
description: "the endpoint that will be used as prefix if the service response returns a relative path for getting the\n long-running operation status and final result."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.core.util.polling.PollingStrategyOptions.getHttpPipeline()"
|
|
fullName: "com.azure.core.util.polling.PollingStrategyOptions.getHttpPipeline()"
|
|
name: "getHttpPipeline()"
|
|
nameWithType: "PollingStrategyOptions.getHttpPipeline()"
|
|
summary: "Returns <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for polling and getting the final result of the long-running operation."
|
|
syntax: "public HttpPipeline getHttpPipeline()"
|
|
desc: "Returns <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for polling and getting the final result of the long-running operation."
|
|
returns:
|
|
description: "<xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for polling and getting the final result of the long-running operation."
|
|
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.util.polling.PollingStrategyOptions.getSerializer()"
|
|
fullName: "com.azure.core.util.polling.PollingStrategyOptions.getSerializer()"
|
|
name: "getSerializer()"
|
|
nameWithType: "PollingStrategyOptions.getSerializer()"
|
|
summary: "Returns the serializer to use for serializing and deserializing the request and response."
|
|
syntax: "public ObjectSerializer getSerializer()"
|
|
desc: "Returns the serializer to use for serializing and deserializing the request and response."
|
|
returns:
|
|
description: "the serializer to use for serializing and deserializing the request and response."
|
|
type: "<xref href=\"com.azure.core.util.serializer.ObjectSerializer?alt=com.azure.core.util.serializer.ObjectSerializer&text=ObjectSerializer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.util.polling.PollingStrategyOptions.getServiceVersion()"
|
|
fullName: "com.azure.core.util.polling.PollingStrategyOptions.getServiceVersion()"
|
|
name: "getServiceVersion()"
|
|
nameWithType: "PollingStrategyOptions.getServiceVersion()"
|
|
summary: "Returns the service version that will be added as query param to each polling request and final result request URL."
|
|
syntax: "public String getServiceVersion()"
|
|
desc: "Returns the service version that will be added as query param to each polling request and final result request URL. If the request URL already contains a service version, it will be replaced by the service version set in this constructor."
|
|
returns:
|
|
description: "the service version to use for polling and getting the final result."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.core.util.polling.PollingStrategyOptions.setContext(com.azure.core.util.Context)"
|
|
fullName: "com.azure.core.util.polling.PollingStrategyOptions.setContext(Context context)"
|
|
name: "setContext(Context context)"
|
|
nameWithType: "PollingStrategyOptions.setContext(Context context)"
|
|
summary: "Sets the context to use for sending the request using the <xref uid=\"com.azure.core.util.polling.PollingStrategyOptions.getHttpPipeline()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getHttpPipeline()\"></xref>."
|
|
parameters:
|
|
- description: "the context to use for sending the request using the <xref uid=\"com.azure.core.util.polling.PollingStrategyOptions.getHttpPipeline()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getHttpPipeline()\"></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 PollingStrategyOptions setContext(Context context)"
|
|
desc: "Sets the context to use for sending the request using the <xref uid=\"com.azure.core.util.polling.PollingStrategyOptions.getHttpPipeline()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getHttpPipeline()\"></xref>."
|
|
returns:
|
|
description: "the updated <xref uid=\"com.azure.core.util.polling.PollingStrategyOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollingStrategyOptions\"></xref> instance."
|
|
type: "<xref href=\"com.azure.core.util.polling.PollingStrategyOptions?alt=com.azure.core.util.polling.PollingStrategyOptions&text=PollingStrategyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.util.polling.PollingStrategyOptions.setEndpoint(java.lang.String)"
|
|
fullName: "com.azure.core.util.polling.PollingStrategyOptions.setEndpoint(String endpoint)"
|
|
name: "setEndpoint(String endpoint)"
|
|
nameWithType: "PollingStrategyOptions.setEndpoint(String endpoint)"
|
|
summary: "Sets the endpoint that will be used as prefix if the service response returns a relative path for getting the long-running operation status and final result."
|
|
parameters:
|
|
- description: "the endpoint that will be used as prefix if the service response returns a relative path for getting the\n long-running operation status and final result."
|
|
name: "endpoint"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PollingStrategyOptions setEndpoint(String endpoint)"
|
|
desc: "Sets the endpoint that will be used as prefix if the service response returns a relative path for getting the long-running operation status and final result."
|
|
returns:
|
|
description: "the updated <xref uid=\"com.azure.core.util.polling.PollingStrategyOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollingStrategyOptions\"></xref> instance."
|
|
type: "<xref href=\"com.azure.core.util.polling.PollingStrategyOptions?alt=com.azure.core.util.polling.PollingStrategyOptions&text=PollingStrategyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.util.polling.PollingStrategyOptions.setSerializer(com.azure.core.util.serializer.ObjectSerializer)"
|
|
fullName: "com.azure.core.util.polling.PollingStrategyOptions.setSerializer(ObjectSerializer serializer)"
|
|
name: "setSerializer(ObjectSerializer serializer)"
|
|
nameWithType: "PollingStrategyOptions.setSerializer(ObjectSerializer serializer)"
|
|
summary: "Set the serializer to use for serializing and deserializing the request and response."
|
|
parameters:
|
|
- description: "the serializer to use for serializing and deserializing the request and response."
|
|
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 PollingStrategyOptions setSerializer(ObjectSerializer serializer)"
|
|
desc: "Set the serializer to use for serializing and deserializing the request and response."
|
|
returns:
|
|
description: "the updated <xref uid=\"com.azure.core.util.polling.PollingStrategyOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollingStrategyOptions\"></xref> instance."
|
|
type: "<xref href=\"com.azure.core.util.polling.PollingStrategyOptions?alt=com.azure.core.util.polling.PollingStrategyOptions&text=PollingStrategyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.util.polling.PollingStrategyOptions.setServiceVersion(java.lang.String)"
|
|
fullName: "com.azure.core.util.polling.PollingStrategyOptions.setServiceVersion(String serviceVersion)"
|
|
name: "setServiceVersion(String serviceVersion)"
|
|
nameWithType: "PollingStrategyOptions.setServiceVersion(String serviceVersion)"
|
|
summary: "Sets the service version that will be added as query param to each polling request and final result request URL."
|
|
parameters:
|
|
- description: "the service version to use for polling and getting the final result."
|
|
name: "serviceVersion"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PollingStrategyOptions setServiceVersion(String serviceVersion)"
|
|
desc: "Sets the service version that will be added as query param to each polling request and final result request URL. If the request URL already contains a service version, it will be replaced by the service version set in this constructor."
|
|
returns:
|
|
description: "the updated <xref uid=\"com.azure.core.util.polling.PollingStrategyOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollingStrategyOptions\"></xref> instance."
|
|
type: "<xref href=\"com.azure.core.util.polling.PollingStrategyOptions?alt=com.azure.core.util.polling.PollingStrategyOptions&text=PollingStrategyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Options to configure polling strategy."
|
|
metadata: {}
|
|
package: "com.azure.core.util.polling"
|
|
artifact: com.azure:azure-core:1.54.0
|