Google LongRunning Client - Class WaitOperationRequest (0.2.6)

Reference documentation and code samples for the Google LongRunning Client class WaitOperationRequest.

The request message for Operations.WaitOperation.

Generated from protobuf message google.longrunning.WaitOperationRequest

Namespace

Google \ LongRunning

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The name of the operation resource to wait on.

↳ timeout Google\Protobuf\Duration

The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

getName

The name of the operation resource to wait on.

Returns
TypeDescription
string

setName

The name of the operation resource to wait on.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTimeout

The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol.

If RPC context deadline is also specified, the shorter one will be used.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasTimeout

clearTimeout

setTimeout

The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol.

If RPC context deadline is also specified, the shorter one will be used.

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