Cloud PubSub V1 Client - Class Snapshot (1.48.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class Snapshot.

A snapshot resource. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

Generated from protobuf message google.pubsub.v1.Snapshot

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The name of the snapshot.

↳ topic string

The name of the topic from which this snapshot is retaining messages.

↳ expire_time Google\Protobuf\Timestamp

The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is 7 days - (age of oldest unacked message in the subscription). For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.

↳ labels array|Google\Protobuf\Internal\MapField

See Creating and managing labels.

getName

The name of the snapshot.

Returns
TypeDescription
string

setName

The name of the snapshot.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTopic

The name of the topic from which this snapshot is retaining messages.

Returns
TypeDescription
string

setTopic

The name of the topic from which this snapshot is retaining messages.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getExpireTime

The snapshot is guaranteed to exist up until this time.

A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is 7 days - (age of oldest unacked message in the subscription). For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasExpireTime

clearExpireTime

setExpireTime

The snapshot is guaranteed to exist up until this time.

A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is 7 days - (age of oldest unacked message in the subscription). For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.

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

getLabels

See Creating and managing labels.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

See Creating and managing labels.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this