Class: Google::Pubsub::V1::Snapshot

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb

Overview

A snapshot resource.

ALPHA: This feature is part of an alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Instance Attribute Summary collapse

Instance Attribute Details

#expire_time ⇒ Google::Protobuf::Timestamp

Returns 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:

  • (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.



544
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 544

class Snapshot; end

#labels ⇒ Hash{String => String}

Returns User labels.

Returns:

  • (Hash{String => String}) —

    User labels.



544
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 544

class Snapshot; end

#name ⇒ String

Returns The name of the snapshot.

Returns:

  • (String) —

    The name of the snapshot.



544
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 544

class Snapshot; end

#topic ⇒ String

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

Returns:

  • (String) —

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



544
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 544

class Snapshot; end