Cloud Spanner V1 Client - Class Send (2.1.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class Send.

Arguments to send operations.

Generated from protobuf message google.spanner.v1.Mutation.Send

Namespace

Google \ Cloud \ Spanner \ V1 \ Mutation

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ queue string

Required. The queue to which the message will be sent.

↳ key Google\Protobuf\ListValue

Required. The primary key of the message to be sent.

↳ deliver_time Google\Protobuf\Timestamp

The time at which Spanner will begin attempting to deliver the message. If deliver_time is not set, Spanner will deliver the message immediately. If deliver_time is in the past, Spanner will replace it with a value closer to the current time.

↳ payload Google\Protobuf\Value

The payload of the message.

getQueue

Required. The queue to which the message will be sent.

Returns
Type Description
string

setQueue

Required. The queue to which the message will be sent.

Parameter
Name Description
var string
Returns
Type Description
$this

getKey

Required. The primary key of the message to be sent.

Returns
Type Description
Google\Protobuf\ListValue|null

hasKey

clearKey

setKey

Required. The primary key of the message to be sent.

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

getDeliverTime

The time at which Spanner will begin attempting to deliver the message.

If deliver_time is not set, Spanner will deliver the message immediately. If deliver_time is in the past, Spanner will replace it with a value closer to the current time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeliverTime

clearDeliverTime

setDeliverTime

The time at which Spanner will begin attempting to deliver the message.

If deliver_time is not set, Spanner will deliver the message immediately. If deliver_time is in the past, Spanner will replace it with a value closer to the current time.

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

getPayload

The payload of the message.

Returns
Type Description
Google\Protobuf\Value|null

hasPayload

clearPayload

setPayload

The payload of the message.

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