com.google.pubsub.v1

Class Snapshot.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

com.google.pubsub.v1.Snapshot.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SnapshotOrBuilder, java.lang.Cloneable

Enclosing class:

Snapshot

public static final class Snapshot.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>
implements SnapshotOrBuilder

 A snapshot resource.
 

Protobuf type google.pubsub.v1.Snapshot

Method Summary

Modifier and Type	Method and Description
Snapshot.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Snapshot	build()
Snapshot	buildPartial()
Snapshot.Builder	clear()
Snapshot.Builder	clearExpireTime() The snapshot is guaranteed to exist up until this time.
Snapshot.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Snapshot.Builder	clearLabels()
Snapshot.Builder	clearName() The name of the snapshot.
Snapshot.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Snapshot.Builder	clearTopic() The name of the topic from which this snapshot is retaining messages.
Snapshot.Builder	clone()
boolean	containsLabels(java.lang.String key) User labels.
Snapshot	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.Timestamp	getExpireTime() The snapshot is guaranteed to exist up until this time.
com.google.protobuf.Timestamp.Builder	getExpireTimeBuilder() 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.util.Map<java.lang.String,java.lang.String>	getMutableLabels() Deprecated.
java.lang.String	getName() The name of the snapshot.
SnapshotName	getNameAsSnapshotName()
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.
TopicName	getTopicAsTopicName()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
Snapshot.Builder	mergeExpireTime(com.google.protobuf.Timestamp value) The snapshot is guaranteed to exist up until this time.
Snapshot.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Snapshot.Builder	mergeFrom(com.google.protobuf.Message other)
Snapshot.Builder	mergeFrom(Snapshot other)
Snapshot.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Snapshot.Builder	putAllLabels(java.util.Map<java.lang.String,java.lang.String> values) User labels.
Snapshot.Builder	putLabels(java.lang.String key, java.lang.String value) User labels.
Snapshot.Builder	removeLabels(java.lang.String key) User labels.
Snapshot.Builder	setExpireTime(com.google.protobuf.Timestamp.Builder builderForValue) The snapshot is guaranteed to exist up until this time.
Snapshot.Builder	setExpireTime(com.google.protobuf.Timestamp value) The snapshot is guaranteed to exist up until this time.
Snapshot.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Snapshot.Builder	setName(java.lang.String value) The name of the snapshot.
Snapshot.Builder	setNameBytes(com.google.protobuf.ByteString value) The name of the snapshot.
Snapshot.Builder	setNameWithSnapshotName(SnapshotName value)
Snapshot.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Snapshot.Builder	setTopic(java.lang.String value) The name of the topic from which this snapshot is retaining messages.
Snapshot.Builder	setTopicBytes(com.google.protobuf.ByteString value) The name of the topic from which this snapshot is retaining messages.
Snapshot.Builder	setTopicWithTopicName(TopicName value)
Snapshot.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

internalGetMutableMapField

protected com.google.protobuf.MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

clear

public Snapshot.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

getDefaultInstanceForType

public Snapshot getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Snapshot build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Snapshot buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Snapshot.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

setField

public Snapshot.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 java.lang.Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

clearField

public Snapshot.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

clearOneof

public Snapshot.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

setRepeatedField

public Snapshot.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         java.lang.Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

addRepeatedField

public Snapshot.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         java.lang.Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

mergeFrom

public Snapshot.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Snapshot.Builder>

mergeFrom

public Snapshot.Builder mergeFrom(Snapshot other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

mergeFrom

public Snapshot.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Snapshot.Builder>

Throws:

java.io.IOException

getName

public java.lang.String getName()

 The name of the snapshot.
 

string name = 1;

Specified by:

getName in interface SnapshotOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The name of the snapshot.
 

string name = 1;

Specified by:

getNameBytes in interface SnapshotOrBuilder

setName

public Snapshot.Builder setName(java.lang.String value)

 The name of the snapshot.
 

string name = 1;

clearName

public Snapshot.Builder clearName()

 The name of the snapshot.
 

string name = 1;

setNameBytes

public Snapshot.Builder setNameBytes(com.google.protobuf.ByteString value)

 The name of the snapshot.
 

string name = 1;

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 com.google.protobuf.ByteString getTopicBytes()

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

string topic = 2;

Specified by:

getTopicBytes in interface SnapshotOrBuilder

setTopic

public Snapshot.Builder setTopic(java.lang.String value)

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

string topic = 2;

clearTopic

public Snapshot.Builder clearTopic()

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

string topic = 2;

setTopicBytes

public Snapshot.Builder setTopicBytes(com.google.protobuf.ByteString value)

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

string topic = 2;

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

Specified by:

getExpireTime in interface SnapshotOrBuilder

setExpireTime

public Snapshot.Builder setExpireTime(com.google.protobuf.Timestamp value)

 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;

setExpireTime

public Snapshot.Builder setExpireTime(com.google.protobuf.Timestamp.Builder builderForValue)

 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;

mergeExpireTime

public Snapshot.Builder mergeExpireTime(com.google.protobuf.Timestamp value)

 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;

clearExpireTime

public Snapshot.Builder clearExpireTime()

 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;

getExpireTimeBuilder

public com.google.protobuf.Timestamp.Builder getExpireTimeBuilder()

 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

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

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

clearLabels

public Snapshot.Builder clearLabels()

removeLabels

public Snapshot.Builder removeLabels(java.lang.String key)

 User labels.
 

map<string, string> labels = 4;

getMutableLabels

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

Deprecated.

Use alternate mutation accessors instead.

putLabels

public Snapshot.Builder putLabels(java.lang.String key,
                                  java.lang.String value)

 User labels.
 

map<string, string> labels = 4;

putAllLabels

public Snapshot.Builder putAllLabels(java.util.Map<java.lang.String,java.lang.String> values)

 User labels.
 

map<string, string> labels = 4;

setUnknownFields

public final Snapshot.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

mergeUnknownFields

public final Snapshot.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Snapshot.Builder>

setNameWithSnapshotName

public final Snapshot.Builder setNameWithSnapshotName(SnapshotName value)

getNameAsSnapshotName

public final SnapshotName getNameAsSnapshotName()

setTopicWithTopicName

public final Snapshot.Builder setTopicWithTopicName(TopicName value)

getTopicAsTopicName

public final TopicName getTopicAsTopicName()