1. class
  2. Google
  3. \
  4. Rpc
  5. \
  6. RetryInfo

RetryInfo

class RetryInfo extends Message

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

Properties

protected $retry_delay Clients should wait at least this long between retrying the same request.

Methods

__construct(array $data = NULL)

Constructor.

Duration|null
getRetryDelay()

Clients should wait at least this long between retrying the same request.

hasRetryDelay()

No description

clearRetryDelay()

No description

$this
setRetryDelay(Duration $var)

Clients should wait at least this long between retrying the same request.

Details

at line 45
__construct(array $data = NULL)

Constructor.

Parameters

array $data { 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.

}

at line 56
Duration|null getRetryDelay()

Clients should wait at least this long between retrying the same request.

Generated from protobuf field .google.protobuf.Duration retry_delay = 1;

Return Value

Duration|null

at line 61
hasRetryDelay()

at line 66
clearRetryDelay()

at line 78
$this setRetryDelay(Duration $var)

Clients should wait at least this long between retrying the same request.

Generated from protobuf field .google.protobuf.Duration retry_delay = 1;

Parameters

Duration $var

Return Value

$this