RetryInfo
extends Message
in package
Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.
It's always recommended that clients should use exponential backoff when
retrying.
Clients should wait until retry_delay amount of time has passed since
receiving the error response before retrying. If retrying requests also
fail, clients should use an exponential backoff scheme to gradually increase
the delay between retries based on retry_delay, until either a maximum
number of retries have been reached or a maximum retry delay cap has been
reached.
Generated from protobuf message google.rpc.RetryInfo
Table of Contents
Properties
- $retry_delay : mixed
- Clients should wait at least this long between retrying the same request.
Methods
- __construct() : mixed
- Constructor.
- clearRetryDelay() : mixed
- getRetryDelay() : Duration|null
- Clients should wait at least this long between retrying the same request.
- hasRetryDelay() : mixed
- setRetryDelay() : $this
- Clients should wait at least this long between retrying the same request.
Properties
$retry_delay
Clients should wait at least this long between retrying the same request.
protected
mixed
$retry_delay
= null
Generated from protobuf field .google.protobuf.Duration retry_delay = 1 [json_name = "retryDelay"];
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
- $data : array<string|int, mixed> = NULL
-
{ Optional. Data for populating the Message object.
@type \Google\Protobuf\Duration $retry_delay Clients should wait at least this long between retrying the same request.}
clearRetryDelay()
public
clearRetryDelay() : mixed
getRetryDelay()
Clients should wait at least this long between retrying the same request.
public
getRetryDelay() : Duration|null
Generated from protobuf field .google.protobuf.Duration retry_delay = 1 [json_name = "retryDelay"];
Return values
Duration|nullhasRetryDelay()
public
hasRetryDelay() : mixed
setRetryDelay()
Clients should wait at least this long between retrying the same request.
public
setRetryDelay(Duration $var) : $this
Generated from protobuf field .google.protobuf.Duration retry_delay = 1 [json_name = "retryDelay"];
Parameters
- $var : Duration