Cloud Spanner V1 Client - Class Ack (2.2.0)

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

Arguments to ack operations.

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

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 where the message to be acked is stored.

↳ key
Google\Protobuf\ListValue

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

↳ ignore_not_found
bool

By default, an attempt to ack a message that does not exist will fail with a NOT_FOUND error. With ignore_not_found set to true, the ack will succeed even if the message does not exist. This is useful for unconditionally acking a message, even if it is missing or has already been acked.

getQueue

Required. The queue where the message to be acked is stored.

Returns
Type
Description
string

setQueue

Required. The queue where the message to be acked is stored.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getKey

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

Returns
Type
Description

hasKey

clearKey

setKey

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

Parameter
Name
Description
Returns
Type
Description
$this

getIgnoreNotFound

By default, an attempt to ack a message that does not exist will fail with a NOT_FOUND error. With ignore_not_found set to true, the ack will succeed even if the message does not exist. This is useful for unconditionally acking a message, even if it is missing or has already been acked.

Returns
Type
Description
bool

setIgnoreNotFound

By default, an attempt to ack a message that does not exist will fail with a NOT_FOUND error. With ignore_not_found set to true, the ack will succeed even if the message does not exist. This is useful for unconditionally acking a message, even if it is missing or has already been acked.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: