Package com.google.pubsub.v1
Interface SnapshotOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Snapshot
,Snapshot.Builder
public interface SnapshotOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionboolean
containsLabels
(String key) See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).com.google.protobuf.Timestamp
The snapshot is guaranteed to exist up until this time.com.google.protobuf.TimestampOrBuilder
The snapshot is guaranteed to exist up until this time.Deprecated.int
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).getLabelsOrDefault
(String key, String defaultValue) See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).getLabelsOrThrow
(String key) See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).getName()
The name of the snapshot.com.google.protobuf.ByteString
The name of the snapshot.getTopic()
The name of the topic from which this snapshot is retaining messages.com.google.protobuf.ByteString
The name of the topic from which this snapshot is retaining messages.boolean
The snapshot is guaranteed to exist up until this time.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()The name of the snapshot.
string name = 1;
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()The name of the snapshot.
string name = 1;
- Returns:
- The bytes for name.
-
getTopic
String getTopic()The name of the topic from which this snapshot is retaining messages.
string topic = 2 [(.google.api.resource_reference) = { ... }
- Returns:
- The topic.
-
getTopicBytes
com.google.protobuf.ByteString getTopicBytes()The name of the topic from which this snapshot is retaining messages.
string topic = 2 [(.google.api.resource_reference) = { ... }
- Returns:
- The bytes for topic.
-
hasExpireTime
boolean hasExpireTime()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.
.google.protobuf.Timestamp expire_time = 3;
- Returns:
- Whether the expireTime field is set.
-
getExpireTime
com.google.protobuf.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. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.
.google.protobuf.Timestamp expire_time = 3;
- Returns:
- The expireTime.
-
getExpireTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()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.
.google.protobuf.Timestamp expire_time = 3;
-
getLabelsCount
int getLabelsCount()See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 4;
-
containsLabels
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 4;
-
getLabels
Deprecated.UsegetLabelsMap()
instead. -
getLabelsMap
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 4;
-
getLabelsOrDefault
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 4;
-
getLabelsOrThrow
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 4;
-