78 строки
8.1 KiB
YAML
78 строки
8.1 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.common.policy.ServiceTimeoutPolicy"
|
|
fullName: "com.azure.storage.common.policy.ServiceTimeoutPolicy"
|
|
name: "ServiceTimeoutPolicy"
|
|
nameWithType: "ServiceTimeoutPolicy"
|
|
summary: "Pipeline policy that sets the timeout URI query parameter to cancel requests on the service side if the server timeout interval elapses before the service has finished processing the request."
|
|
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 **ServiceTimeoutPolicy**</br> implements <xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.storage.common.policy.ServiceTimeoutPolicy.ServiceTimeoutPolicy(java.time.Duration)"
|
|
fullName: "com.azure.storage.common.policy.ServiceTimeoutPolicy.ServiceTimeoutPolicy(Duration timeout)"
|
|
name: "ServiceTimeoutPolicy(Duration timeout)"
|
|
nameWithType: "ServiceTimeoutPolicy.ServiceTimeoutPolicy(Duration timeout)"
|
|
summary: "Creates a service timeout policy."
|
|
parameters:
|
|
- description: "The timeout duration."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public ServiceTimeoutPolicy(Duration timeout)"
|
|
desc: "Creates a service timeout policy.\n\nThe maximum timeout interval for Blob service operations is 30 seconds, with exceptions for certain operations. The default value is also 30 seconds, although some read and write operations may use a larger default. Apart from these exceptions, the service automatically reduces any timeouts larger than 30 seconds to the 30-second maximum. For more information, see here: [Setting timeouts for blob service operations][] For more information on setting timeouts for file shares, see here: [Setting timeouts for file service operations][] For more information on setting timeouts on queues, see here: [Setting timeouts for queue service operations][]\n\n\n[Setting timeouts for blob service operations]: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations\n[Setting timeouts for file service operations]: https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-file-service-operations\n[Setting timeouts for queue service operations]: https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations"
|
|
methods:
|
|
- uid: "com.azure.storage.common.policy.ServiceTimeoutPolicy.getPipelinePosition()"
|
|
fullName: "com.azure.storage.common.policy.ServiceTimeoutPolicy.getPipelinePosition()"
|
|
name: "getPipelinePosition()"
|
|
nameWithType: "ServiceTimeoutPolicy.getPipelinePosition()"
|
|
summary: "Gets the position to place the policy."
|
|
syntax: "public HttpPipelinePosition getPipelinePosition()"
|
|
desc: "Gets the position to place the policy."
|
|
returns:
|
|
description: "The position to place the policy."
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelinePosition?alt=com.azure.core.http.HttpPipelinePosition&text=HttpPipelinePosition\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.policy.ServiceTimeoutPolicy.process(com.azure.core.http.HttpPipelineCallContext,com.azure.core.http.HttpPipelineNextPolicy)"
|
|
fullName: "com.azure.storage.common.policy.ServiceTimeoutPolicy.process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
|
|
name: "process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
|
|
nameWithType: "ServiceTimeoutPolicy.process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
|
|
parameters:
|
|
- name: "context"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineCallContext?alt=com.azure.core.http.HttpPipelineCallContext&text=HttpPipelineCallContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "next"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineNextPolicy?alt=com.azure.core.http.HttpPipelineNextPolicy&text=HttpPipelineNextPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<HttpResponse> process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
|
|
returns:
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.HttpResponse?alt=com.azure.core.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.storage.common.policy.ServiceTimeoutPolicy.processSync(com.azure.core.http.HttpPipelineCallContext,com.azure.core.http.HttpPipelineNextSyncPolicy)"
|
|
fullName: "com.azure.storage.common.policy.ServiceTimeoutPolicy.processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
|
|
name: "processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
|
|
nameWithType: "ServiceTimeoutPolicy.processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
|
|
parameters:
|
|
- name: "context"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineCallContext?alt=com.azure.core.http.HttpPipelineCallContext&text=HttpPipelineCallContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "next"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineNextSyncPolicy?alt=com.azure.core.http.HttpPipelineNextSyncPolicy&text=HttpPipelineNextSyncPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HttpResponse processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.core.http.HttpResponse?alt=com.azure.core.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Pipeline policy that sets the timeout URI query parameter to cancel requests on the service side if the server timeout interval elapses before the service has finished processing the request. For more information on timeouts for different services, see here: [Setting timeouts for blob service operations][] [Setting timeouts for file service operations][] [Setting timeouts for queue service operations][]\n\n\n[Setting timeouts for blob service operations]: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations\n[Setting timeouts for file service operations]: https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-file-service-operations\n[Setting timeouts for queue service operations]: https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations"
|
|
implements:
|
|
- "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.azure.storage.common.policy"
|
|
artifact: com.azure:azure-storage-common:12.26.1
|