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 Type	Method and Description
boolean	containsLabels(java.lang.String key) User labels.
com.google.protobuf.Timestamp	getExpireTime() The snapshot is guaranteed to exist up until this time.
com.google.protobuf.TimestampOrBuilder	getExpireTimeOrBuilder() The snapshot is guaranteed to exist up until this time.
java.util.Map<java.lang.String,java.lang.String>	getLabels() Deprecated.
int	getLabelsCount() User labels.
java.util.Map<java.lang.String,java.lang.String>	getLabelsMap() User labels.
java.lang.String	getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue) User labels.
java.lang.String	getLabelsOrThrow(java.lang.String key) User labels.
java.lang.String	getName() The name of the snapshot.
com.google.protobuf.ByteString	getNameBytes() The name of the snapshot.
java.lang.String	getTopic() The name of the topic from which this snapshot is retaining messages.
com.google.protobuf.ByteString	getTopicBytes() The name of the topic from which this snapshot is retaining messages.
boolean	hasExpireTime() The snapshot is guaranteed to exist up until this time.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

java.lang.String getName()

 The name of the snapshot.
 

string name = 1;

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The name of the snapshot.
 

string name = 1;

getTopic

java.lang.String getTopic()

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

string topic = 2;

getTopicBytes

com.google.protobuf.ByteString getTopicBytes()

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

string topic = 2;

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.
 

.google.protobuf.Timestamp expire_time = 3;

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.
 

.google.protobuf.Timestamp expire_time = 3;

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.
 

.google.protobuf.Timestamp expire_time = 3;

getLabelsCount

int getLabelsCount()

 User labels.
 

map<string, string> labels = 4;

containsLabels

boolean containsLabels(java.lang.String key)

 User labels.
 

map<string, string> labels = 4;

getLabels

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

java.util.Map<java.lang.String,java.lang.String> getLabelsMap()

 User labels.
 

map<string, string> labels = 4;

getLabelsOrDefault

java.lang.String getLabelsOrDefault(java.lang.String key,
                                    java.lang.String defaultValue)

 User labels.
 

map<string, string> labels = 4;

getLabelsOrThrow

java.lang.String getLabelsOrThrow(java.lang.String key)

 User labels.
 

map<string, string> labels = 4;