Google Cloud Deploy V1 Client - Class Retry (0.16.0)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class Retry.

Retries the failed job.

Generated from protobuf message google.cloud.deploy.v1.Retry

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ attempts int|string

Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.

↳ wait Google\Protobuf\Duration

Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.

↳ backoff_mode int

Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if wait is 0.

getAttempts

Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.

Returns
TypeDescription
int|string

setAttempts

Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getWait

Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasWait

clearWait

setWait

Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getBackoffMode

Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if wait is 0.

Returns
TypeDescription
int

setBackoffMode

Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if wait is 0.

Parameter
NameDescription
var int
Returns
TypeDescription
$this