Snapshot
class Snapshot extends Message
A snapshot resource.
Protobuf type Google\Pubsub\V1\Snapshot
Methods
No description
The name of the snapshot.
The name of the snapshot.
The name of the topic from which this snapshot is retaining messages.
The name of the topic from which this snapshot is retaining messages.
The snapshot is guaranteed to exist up until this time.
Details
at line 45
__construct()
at line 56
string
getName()
The name of the snapshot.
Generated from protobuf field string name = 1;
at line 67
setName(string $var)
The name of the snapshot.
Generated from protobuf field string name = 1;
at line 79
string
getTopic()
The name of the topic from which this snapshot is retaining messages.
Generated from protobuf field string topic = 2;
at line 90
setTopic(string $var)
The name of the topic from which this snapshot is retaining messages.
Generated from protobuf field string topic = 2;
at line 110
Timestamp
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.
Generated from protobuf field .google.protobuf.Timestamp expire_time = 3;
at line 129
setExpireTime(Timestamp $var)
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.
Generated from protobuf field .google.protobuf.Timestamp expire_time = 3;