Documentation

LongRunning extends Message
in package

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

Table of Contents

Properties

$initial_poll_delay  : mixed
Initial delay after which the first poll request will be made.
$max_poll_delay  : mixed
Maximum time between two subsequent poll requests.
$poll_delay_multiplier  : mixed
Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.
$total_poll_timeout  : mixed
Total polling timeout.

Methods

__construct()  : mixed
Constructor.
clearInitialPollDelay()  : mixed
clearMaxPollDelay()  : mixed
clearTotalPollTimeout()  : mixed
getInitialPollDelay()  : Duration|null
Initial delay after which the first poll request will be made.
getMaxPollDelay()  : Duration|null
Maximum time between two subsequent poll requests.
getPollDelayMultiplier()  : float
Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.
getTotalPollTimeout()  : Duration|null
Total polling timeout.
hasInitialPollDelay()  : mixed
hasMaxPollDelay()  : mixed
hasTotalPollTimeout()  : mixed
setInitialPollDelay()  : $this
Initial delay after which the first poll request will be made.
setMaxPollDelay()  : $this
Maximum time between two subsequent poll requests.
setPollDelayMultiplier()  : $this
Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.
setTotalPollTimeout()  : $this
Total polling timeout.

Properties

$initial_poll_delay

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

protected mixed $initial_poll_delay = null

Default value: 5 seconds.

Generated from protobuf field .google.protobuf.Duration initial_poll_delay = 1 [json_name = "initialPollDelay"];

$max_poll_delay

Maximum time between two subsequent poll requests.

protected mixed $max_poll_delay = null

Default value: 45 seconds.

Generated from protobuf field .google.protobuf.Duration max_poll_delay = 3 [json_name = "maxPollDelay"];

$poll_delay_multiplier

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

protected mixed $poll_delay_multiplier = 0.0

Default value: 1.5.

Generated from protobuf field float poll_delay_multiplier = 2 [json_name = "pollDelayMultiplier"];

$total_poll_timeout

Total polling timeout.

protected mixed $total_poll_timeout = null

Default value: 5 minutes.

Generated from protobuf field .google.protobuf.Duration total_poll_timeout = 4 [json_name = "totalPollTimeout"];

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 $initial_poll_delay
      Initial delay after which the first poll request will be made.
      Default value: 5 seconds.
@type float $poll_delay_multiplier
      Multiplier to gradually increase delay between subsequent polls until it
      reaches max_poll_delay.
      Default value: 1.5.
@type \Google\Protobuf\Duration $max_poll_delay
      Maximum time between two subsequent poll requests.
      Default value: 45 seconds.
@type \Google\Protobuf\Duration $total_poll_timeout
      Total polling timeout.
      Default value: 5 minutes.

}

clearInitialPollDelay()

public clearInitialPollDelay() : mixed

clearMaxPollDelay()

public clearMaxPollDelay() : mixed

clearTotalPollTimeout()

public clearTotalPollTimeout() : mixed

getInitialPollDelay()

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

public getInitialPollDelay() : Duration|null

Default value: 5 seconds.

Generated from protobuf field .google.protobuf.Duration initial_poll_delay = 1 [json_name = "initialPollDelay"];

Return values
Duration|null

getMaxPollDelay()

Maximum time between two subsequent poll requests.

public getMaxPollDelay() : Duration|null

Default value: 45 seconds.

Generated from protobuf field .google.protobuf.Duration max_poll_delay = 3 [json_name = "maxPollDelay"];

Return values
Duration|null

getPollDelayMultiplier()

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

public getPollDelayMultiplier() : float

Default value: 1.5.

Generated from protobuf field float poll_delay_multiplier = 2 [json_name = "pollDelayMultiplier"];

Return values
float

getTotalPollTimeout()

Total polling timeout.

public getTotalPollTimeout() : Duration|null

Default value: 5 minutes.

Generated from protobuf field .google.protobuf.Duration total_poll_timeout = 4 [json_name = "totalPollTimeout"];

Return values
Duration|null

hasInitialPollDelay()

public hasInitialPollDelay() : mixed

hasTotalPollTimeout()

public hasTotalPollTimeout() : mixed

setInitialPollDelay()

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

public setInitialPollDelay(Duration $var) : $this

Default value: 5 seconds.

Generated from protobuf field .google.protobuf.Duration initial_poll_delay = 1 [json_name = "initialPollDelay"];

Parameters
$var : Duration
Return values
$this

setMaxPollDelay()

Maximum time between two subsequent poll requests.

public setMaxPollDelay(Duration $var) : $this

Default value: 45 seconds.

Generated from protobuf field .google.protobuf.Duration max_poll_delay = 3 [json_name = "maxPollDelay"];

Parameters
$var : Duration
Return values
$this

setPollDelayMultiplier()

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

public setPollDelayMultiplier(float $var) : $this

Default value: 1.5.

Generated from protobuf field float poll_delay_multiplier = 2 [json_name = "pollDelayMultiplier"];

Parameters
$var : float
Return values
$this

setTotalPollTimeout()

Total polling timeout.

public setTotalPollTimeout(Duration $var) : $this

Default value: 5 minutes.

Generated from protobuf field .google.protobuf.Duration total_poll_timeout = 4 [json_name = "totalPollTimeout"];

Parameters
$var : Duration
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results