com.google.api.services.pubsub.model

Class Snapshot

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.pubsub.model.Snapshot

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Snapshot
extends com.google.api.client.json.GenericJson

A snapshot resource. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Snapshot()

Method Summary

Modifier and Type	Method and Description
Snapshot	clone()
java.lang.String	getExpireTime() The snapshot is guaranteed to exist up until this time.
java.util.Map<java.lang.String,java.lang.String>	getLabels() See Creating and managing labels.
java.lang.String	getName() The name of the snapshot.
java.lang.String	getTopic() The name of the topic from which this snapshot is retaining messages.
Snapshot	set(java.lang.String fieldName, java.lang.Object value)
Snapshot	setExpireTime(java.lang.String expireTime) The snapshot is guaranteed to exist up until this time.
Snapshot	setLabels(java.util.Map<java.lang.String,java.lang.String> labels) See Creating and managing labels.
Snapshot	setName(java.lang.String name) The name of the snapshot.
Snapshot	setTopic(java.lang.String topic) The name of the topic from which this snapshot is retaining messages.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Snapshot

public Snapshot()

Method Detail

getExpireTime

public java.lang.String 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.

Returns:

value or null for none

setExpireTime

public Snapshot setExpireTime(java.lang.String expireTime)

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.

Parameters:

expireTime - expireTime or null for none

getLabels

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

See Creating and managing labels.

Returns:

value or null for none

setLabels

public Snapshot setLabels(java.util.Map<java.lang.String,java.lang.String> labels)

See Creating and managing labels.

Parameters:

labels - labels or null for none

getName

public java.lang.String getName()

The name of the snapshot.

Returns:

value or null for none

setName

public Snapshot setName(java.lang.String name)

The name of the snapshot.

Parameters:

name - name or null for none

getTopic

public java.lang.String getTopic()

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

Returns:

value or null for none

setTopic

public Snapshot setTopic(java.lang.String topic)

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

Parameters:

topic - topic or null for none

set

public Snapshot set(java.lang.String fieldName,
                    java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Snapshot clone()

Overrides:

clone in class com.google.api.client.json.GenericJson