Documentation

WaitOperationRequest extends Message
in package

The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].

Generated from protobuf message google.longrunning.WaitOperationRequest

Table of Contents

Properties

$name  : mixed
The name of the operation resource to wait on.
$timeout  : mixed
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.

Methods

__construct()  : mixed
Constructor.
clearTimeout()  : mixed
getName()  : string
The name of the operation resource to wait on.
getTimeout()  : Duration|null
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.
hasTimeout()  : mixed
setName()  : $this
The name of the operation resource to wait on.
setTimeout()  : $this
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.

Properties

$name

The name of the operation resource to wait on.

protected mixed $name = ''

Generated from protobuf field string name = 1 [json_name = "name"];

$timeout

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.

protected mixed $timeout = null

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

Generated from protobuf field .google.protobuf.Duration timeout = 2 [json_name = "timeout"];

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 string $name
      The name of the operation resource to wait on.
@type \Google\Protobuf\Duration $timeout
      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.

public getName() : string

Generated from protobuf field string name = 1 [json_name = "name"];

Return values
string

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.

public getTimeout() : Duration|null

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

Generated from protobuf field .google.protobuf.Duration timeout = 2 [json_name = "timeout"];

Return values
Duration|null

setName()

The name of the operation resource to wait on.

public setName(string $var) : $this

Generated from protobuf field string name = 1 [json_name = "name"];

Parameters
$var : string
Return values
$this

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.

public setTimeout(Duration $var) : $this

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

Generated from protobuf field .google.protobuf.Duration timeout = 2 [json_name = "timeout"];

Parameters
$var : Duration
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results