Google API Common Protos Client - Class LongRunning (4.8.2)

Reference documentation and code samples for the Google API Common Protos Client class LongRunning.

Describes settings to use when generating API methods that use the long-running operation pattern.

All default values below are from those used in the client library generators (e.g. Java).

Generated from protobuf message google.api.MethodSettings.LongRunning

Namespace

Google \ Api \ MethodSettings

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ initial_poll_delay Google\Protobuf\Duration

Initial delay after which the first poll request will be made. Default value: 5 seconds.

↳ poll_delay_multiplier float

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.

↳ max_poll_delay Google\Protobuf\Duration

Maximum time between two subsequent poll requests. Default value: 45 seconds.

↳ total_poll_timeout Google\Protobuf\Duration

Total polling timeout. Default value: 5 minutes.

getInitialPollDelay

Initial delay after which the first poll request will be made.

Default value: 5 seconds.

Returns
Type Description
Google\Protobuf\Duration|null

hasInitialPollDelay

clearInitialPollDelay

setInitialPollDelay

Initial delay after which the first poll request will be made.

Default value: 5 seconds.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getPollDelayMultiplier

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.

Default value: 1.5.

Returns
Type Description
float

setPollDelayMultiplier

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.

Default value: 1.5.

Parameter
Name Description
var float
Returns
Type Description
$this

getMaxPollDelay

Maximum time between two subsequent poll requests.

Default value: 45 seconds.

Returns
Type Description
Google\Protobuf\Duration|null

hasMaxPollDelay

clearMaxPollDelay

setMaxPollDelay

Maximum time between two subsequent poll requests.

Default value: 45 seconds.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getTotalPollTimeout

Total polling timeout.

Default value: 5 minutes.

Returns
Type Description
Google\Protobuf\Duration|null

hasTotalPollTimeout

clearTotalPollTimeout

setTotalPollTimeout

Total polling timeout.

Default value: 5 minutes.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this