diff --git a/dotnet/docs/api/class-apirequestcontext.mdx b/dotnet/docs/api/class-apirequestcontext.mdx index 75acad5afd..6348de2a3e 100644 --- a/dotnet/docs/api/class-apirequestcontext.mdx +++ b/dotnet/docs/api/class-apirequestcontext.mdx @@ -173,6 +173,9 @@ await Request.FetchAsync("https://example.com/api/uploadScript", new() { Method - `MaxRedirects` [int]? *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `MaxRetries` [int]? *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `Method` [string]? *(optional)*# If set changes the fetch method (e.g. [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) or [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST)). If not specified, GET method is used. @@ -237,6 +240,9 @@ await request.GetAsync("https://example.com/api/getText", new() { Params = query - `MaxRedirects` [int]? *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `MaxRetries` [int]? *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `Multipart` [FormData]? *(optional)* Added in: v1.26# Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content. @@ -291,6 +297,9 @@ await ApiRequestContext.HeadAsync(url, options); - `MaxRedirects` [int]? *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `MaxRetries` [int]? *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `Multipart` [FormData]? *(optional)* Added in: v1.26# Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content. @@ -345,6 +354,9 @@ await ApiRequestContext.PatchAsync(url, options); - `MaxRedirects` [int]? *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `MaxRetries` [int]? *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `Multipart` [FormData]? *(optional)*# Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content. @@ -428,6 +440,9 @@ await request.PostAsync("https://example.com/api/uploadScript", new() { Multipar - `MaxRedirects` [int]? *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `MaxRetries` [int]? *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `Multipart` [FormData]? *(optional)*# Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content. @@ -482,6 +497,9 @@ await ApiRequestContext.PutAsync(url, options); - `MaxRedirects` [int]? *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `MaxRetries` [int]? *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `Multipart` [FormData]? *(optional)*# Provides an object that will be serialized as html form using `multipart/form-data` encoding and sent as this request body. If this parameter is specified `content-type` header will be set to `multipart/form-data` unless explicitly provided. File values can be passed as file-like object containing file name, mime-type and its content. diff --git a/java/docs/api/class-requestoptions.mdx b/java/docs/api/class-requestoptions.mdx index 643769bf69..9707750a55 100644 --- a/java/docs/api/class-requestoptions.mdx +++ b/java/docs/api/class-requestoptions.mdx @@ -196,6 +196,26 @@ RequestOptions.setMaxRedirects(maxRedirects); --- +### setMaxRetries {#request-options-set-max-retries} + +Added in: v1.46requestOptions.setMaxRetries + +**Usage** + +```java +RequestOptions.setMaxRetries(maxRetries); +``` + +**Arguments** +- `maxRetries` [int]# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. + +**Returns** +- [RequestOptions]# + +--- + ### setMethod {#request-options-set-method} Added in: v1.18requestOptions.setMethod diff --git a/nodejs/docs/api/class-apirequestcontext.mdx b/nodejs/docs/api/class-apirequestcontext.mdx index da099a56b9..b5c82508bc 100644 --- a/nodejs/docs/api/class-apirequestcontext.mdx +++ b/nodejs/docs/api/class-apirequestcontext.mdx @@ -163,6 +163,9 @@ await request.fetch('https://example.com/api/uploadForm', { - `maxRedirects` [number] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `maxRetries` [number] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `method` [string] *(optional)*# If set changes the fetch method (e.g. [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) or [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST)). If not specified, GET method is used. @@ -232,6 +235,9 @@ await request.get('https://example.com/api/getText', { - `maxRedirects` [number] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `maxRetries` [number] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `multipart` [FormData] | [Object]<[string], [string] | [number] | [boolean] | [ReadStream] | [Object]> *(optional)* Added in: v1.26# - `name` [string] @@ -292,6 +298,9 @@ await apiRequestContext.head(url, options); - `maxRedirects` [number] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `maxRetries` [number] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `multipart` [FormData] | [Object]<[string], [string] | [number] | [boolean] | [ReadStream] | [Object]> *(optional)* Added in: v1.26# - `name` [string] @@ -352,6 +361,9 @@ await apiRequestContext.patch(url, options); - `maxRedirects` [number] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `maxRetries` [number] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `multipart` [FormData] | [Object]<[string], [string] | [number] | [boolean] | [ReadStream] | [Object]> *(optional)*# - `name` [string] @@ -443,6 +455,9 @@ await request.post('https://example.com/api/uploadForm', { - `maxRedirects` [number] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `maxRetries` [number] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `multipart` [FormData] | [Object]<[string], [string] | [number] | [boolean] | [ReadStream] | [Object]> *(optional)*# - `name` [string] @@ -503,6 +518,9 @@ await apiRequestContext.put(url, options); - `maxRedirects` [number] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. + - `maxRetries` [number] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `multipart` [FormData] | [Object]<[string], [string] | [number] | [boolean] | [ReadStream] | [Object]> *(optional)*# - `name` [string] diff --git a/python/docs/api/class-apirequestcontext.mdx b/python/docs/api/class-apirequestcontext.mdx index 2e63b9b3b7..331938fcb7 100644 --- a/python/docs/api/class-apirequestcontext.mdx +++ b/python/docs/api/class-apirequestcontext.mdx @@ -274,6 +274,9 @@ api_request_context.fetch( - `max_redirects` [int] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. +- `max_retries` [int] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `method` [str] *(optional)*# If set changes the fetch method (e.g. [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) or [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST)). If not specified, GET method is used. @@ -341,6 +344,9 @@ api_request_context.get("https://example.com/api/getText", params=query_params) - `max_redirects` [int] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. +- `max_retries` [int] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `multipart` [Dict]\[[str], [str] | [float] | [bool] | [ReadStream] | [Dict]\] *(optional)* Added in: v1.26# - `name` [str] @@ -400,6 +406,9 @@ api_request_context.head(url, **kwargs) - `max_redirects` [int] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. +- `max_retries` [int] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `multipart` [Dict]\[[str], [str] | [float] | [bool] | [ReadStream] | [Dict]\] *(optional)* Added in: v1.26# - `name` [str] @@ -459,6 +468,9 @@ api_request_context.patch(url, **kwargs) - `max_redirects` [int] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. +- `max_retries` [int] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `multipart` [Dict]\[[str], [str] | [float] | [bool] | [ReadStream] | [Dict]\] *(optional)*# - `name` [str] @@ -547,6 +559,9 @@ api_request_context.post( - `max_redirects` [int] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. +- `max_retries` [int] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `multipart` [Dict]\[[str], [str] | [float] | [bool] | [ReadStream] | [Dict]\] *(optional)*# - `name` [str] @@ -606,6 +621,9 @@ api_request_context.put(url, **kwargs) - `max_redirects` [int] *(optional)* Added in: v1.26# Maximum number of request redirects that will be followed automatically. An error will be thrown if the number is exceeded. Defaults to `20`. Pass `0` to not follow redirects. +- `max_retries` [int] *(optional)* Added in: v1.46# + + Maximum number of times socket errors should be retried. Currently only `ECONNRESET` error is retried. An error will be thrown if the limit is exceeded. Defaults to `0` - no retries. - `multipart` [Dict]\[[str], [str] | [float] | [bool] | [ReadStream] | [Dict]\] *(optional)*# - `name` [str]