com.google.pubsub.v1

Class Snapshot

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.pubsub.v1.Snapshot

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, SnapshotOrBuilder, java.io.Serializable

public final class Snapshot
extends GeneratedMessageV3
implements SnapshotOrBuilder

 A snapshot resource.
 

Protobuf type google.pubsub.v1.Snapshot

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Snapshot.Builder A snapshot resource.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXPIRE_TIME_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	TOPIC_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(java.lang.String key) User labels.
boolean	equals(java.lang.Object obj)
static Snapshot	getDefaultInstance()
Snapshot	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Timestamp	getExpireTime() The snapshot is guaranteed to exist up until this time.
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.
ByteString	getNameBytes() The name of the snapshot.
Parser<Snapshot>	getParserForType()
int	getSerializedSize()
java.lang.String	getTopic() The name of the topic from which this snapshot is retaining messages.
ByteString	getTopicBytes() The name of the topic from which this snapshot is retaining messages.
UnknownFieldSet	getUnknownFields()
boolean	hasExpireTime() The snapshot is guaranteed to exist up until this time.
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
boolean	isInitialized()
static Snapshot.Builder	newBuilder()
static Snapshot.Builder	newBuilder(Snapshot prototype)
Snapshot.Builder	newBuilderForType()
protected Snapshot.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static Snapshot	parseDelimitedFrom(java.io.InputStream input)
static Snapshot	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Snapshot	parseFrom(byte[] data)
static Snapshot	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Snapshot	parseFrom(java.nio.ByteBuffer data)
static Snapshot	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Snapshot	parseFrom(ByteString data)
static Snapshot	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Snapshot	parseFrom(CodedInputStream input)
static Snapshot	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Snapshot	parseFrom(java.io.InputStream input)
static Snapshot	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Snapshot>	parser()
Snapshot.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

TOPIC_FIELD_NUMBER

public static final int TOPIC_FIELD_NUMBER

See Also:

Constant Field Values

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField

protected MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getName

public java.lang.String getName()

 The name of the snapshot.
 

string name = 1;

Specified by:

getName in interface SnapshotOrBuilder

getNameBytes

public ByteString getNameBytes()

 The name of the snapshot.
 

string name = 1;

Specified by:

getNameBytes in interface SnapshotOrBuilder

getTopic

public java.lang.String getTopic()

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

string topic = 2;

Specified by:

getTopic in interface SnapshotOrBuilder

getTopicBytes

public ByteString getTopicBytes()

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

string topic = 2;

Specified by:

getTopicBytes in interface SnapshotOrBuilder

hasExpireTime

public 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;

Specified by:

hasExpireTime in interface SnapshotOrBuilder

getExpireTime

public 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;

Specified by:

getExpireTime in interface SnapshotOrBuilder

getExpireTimeOrBuilder

public 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;

Specified by:

getExpireTimeOrBuilder in interface SnapshotOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: SnapshotOrBuilder

 User labels.
 

map<string, string> labels = 4;

Specified by:

getLabelsCount in interface SnapshotOrBuilder

containsLabels

public boolean containsLabels(java.lang.String key)

 User labels.
 

map<string, string> labels = 4;

Specified by:

containsLabels in interface SnapshotOrBuilder

getLabels

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

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface SnapshotOrBuilder

getLabelsMap

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

 User labels.
 

map<string, string> labels = 4;

Specified by:

getLabelsMap in interface SnapshotOrBuilder

getLabelsOrDefault

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

 User labels.
 

map<string, string> labels = 4;

Specified by:

getLabelsOrDefault in interface SnapshotOrBuilder

getLabelsOrThrow

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

 User labels.
 

map<string, string> labels = 4;

Specified by:

getLabelsOrThrow in interface SnapshotOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Snapshot parseFrom(java.nio.ByteBuffer data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Snapshot parseFrom(java.nio.ByteBuffer data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Snapshot parseFrom(ByteString data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Snapshot parseFrom(ByteString data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Snapshot parseFrom(byte[] data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Snapshot parseFrom(byte[] data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Snapshot parseFrom(java.io.InputStream input)
                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Snapshot parseFrom(java.io.InputStream input,
                                 ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Snapshot parseDelimitedFrom(java.io.InputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Snapshot parseDelimitedFrom(java.io.InputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Snapshot parseFrom(CodedInputStream input)
                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Snapshot parseFrom(CodedInputStream input,
                                 ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Snapshot.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Snapshot.Builder newBuilder()

newBuilder

public static Snapshot.Builder newBuilder(Snapshot prototype)

toBuilder

public Snapshot.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Snapshot.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Snapshot getDefaultInstance()

parser

public static Parser<Snapshot> parser()

getParserForType

public Parser<Snapshot> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Snapshot getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder