Cloud PubSub V1 Client - Class Snapshot (2.4.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
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Optional. The name of the snapshot.
↳ topic string

Optional. The name of the topic from which this snapshot is retaining messages.
↳ expire_time Google\Protobuf\Timestamp

Optional. 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

Optional. See Creating and managing labels.

getName

Optional. The name of the snapshot.

Returns
Type Description
string

setName

Optional. The name of the snapshot.

Parameter
Name Description
var string
Returns
Type Description
$this

getTopic

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

Returns
Type Description
string

setTopic

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

Parameter
Name Description
var string
Returns
Type Description
$this

getExpireTime

Optional. 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
Type Description
Google\Protobuf\Timestamp|null

hasExpireTime

clearExpireTime

setExpireTime

Optional. 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
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

Optional. See Creating and managing labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. See Creating and managing labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this