com.google.pubsub.v1

Class Subscription

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.pubsub.v1.Subscription

All Implemented Interfaces:

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

public final class Subscription
extends GeneratedMessageV3
implements SubscriptionOrBuilder

 A subscription resource.
 

Protobuf type google.pubsub.v1.Subscription

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Subscription.Builder A subscription 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	ACK_DEADLINE_SECONDS_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	MESSAGE_RETENTION_DURATION_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PUSH_CONFIG_FIELD_NUMBER
static int	RETAIN_ACKED_MESSAGES_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)
int	getAckDeadlineSeconds() This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
static Subscription	getDefaultInstance()
Subscription	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
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.
Duration	getMessageRetentionDuration() How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
DurationOrBuilder	getMessageRetentionDurationOrBuilder() How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
java.lang.String	getName() The name of the subscription.
ByteString	getNameBytes() The name of the subscription.
Parser<Subscription>	getParserForType()
PushConfig	getPushConfig() If push delivery is used with this subscription, this field is used to configure it.
PushConfigOrBuilder	getPushConfigOrBuilder() If push delivery is used with this subscription, this field is used to configure it.
boolean	getRetainAckedMessages() Indicates whether to retain acknowledged messages.
int	getSerializedSize()
java.lang.String	getTopic() The name of the topic from which this subscription is receiving messages.
ByteString	getTopicBytes() The name of the topic from which this subscription is receiving messages.
UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasMessageRetentionDuration() How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
boolean	hasPushConfig() If push delivery is used with this subscription, this field is used to configure it.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
boolean	isInitialized()
static Subscription.Builder	newBuilder()
static Subscription.Builder	newBuilder(Subscription prototype)
Subscription.Builder	newBuilderForType()
protected Subscription.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static Subscription	parseDelimitedFrom(java.io.InputStream input)
static Subscription	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Subscription	parseFrom(byte[] data)
static Subscription	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Subscription	parseFrom(java.nio.ByteBuffer data)
static Subscription	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Subscription	parseFrom(ByteString data)
static Subscription	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Subscription	parseFrom(CodedInputStream input)
static Subscription	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Subscription	parseFrom(java.io.InputStream input)
static Subscription	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Subscription>	parser()
Subscription.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

PUSH_CONFIG_FIELD_NUMBER

public static final int PUSH_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

ACK_DEADLINE_SECONDS_FIELD_NUMBER

public static final int ACK_DEADLINE_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

RETAIN_ACKED_MESSAGES_FIELD_NUMBER

public static final int RETAIN_ACKED_MESSAGES_FIELD_NUMBER

See Also:

Constant Field Values

MESSAGE_RETENTION_DURATION_FIELD_NUMBER

public static final int MESSAGE_RETENTION_DURATION_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 subscription. It must have the format
 `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
 start with a letter, and contain only letters (`[A-Za-z]`), numbers
 (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
 plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
 in length, and it must not start with `"goog"`.
 

string name = 1;

Specified by:

getName in interface SubscriptionOrBuilder

getNameBytes

public ByteString getNameBytes()

 The name of the subscription. It must have the format
 `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
 start with a letter, and contain only letters (`[A-Za-z]`), numbers
 (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
 plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
 in length, and it must not start with `"goog"`.
 

string name = 1;

Specified by:

getNameBytes in interface SubscriptionOrBuilder

getTopic

public java.lang.String getTopic()

 The name of the topic from which this subscription is receiving messages.
 Format is `projects/{project}/topics/{topic}`.
 The value of this field will be `_deleted-topic_` if the topic has been
 deleted.
 

string topic = 2;

Specified by:

getTopic in interface SubscriptionOrBuilder

getTopicBytes

public ByteString getTopicBytes()

 The name of the topic from which this subscription is receiving messages.
 Format is `projects/{project}/topics/{topic}`.
 The value of this field will be `_deleted-topic_` if the topic has been
 deleted.
 

string topic = 2;

Specified by:

getTopicBytes in interface SubscriptionOrBuilder

hasPushConfig

public boolean hasPushConfig()

 If push delivery is used with this subscription, this field is
 used to configure it. An empty `pushConfig` signifies that the subscriber
 will pull and ack messages using API methods.
 

.google.pubsub.v1.PushConfig push_config = 4;

Specified by:

hasPushConfig in interface SubscriptionOrBuilder

getPushConfig

public PushConfig getPushConfig()

 If push delivery is used with this subscription, this field is
 used to configure it. An empty `pushConfig` signifies that the subscriber
 will pull and ack messages using API methods.
 

.google.pubsub.v1.PushConfig push_config = 4;

Specified by:

getPushConfig in interface SubscriptionOrBuilder

getPushConfigOrBuilder

public PushConfigOrBuilder getPushConfigOrBuilder()

 If push delivery is used with this subscription, this field is
 used to configure it. An empty `pushConfig` signifies that the subscriber
 will pull and ack messages using API methods.
 

.google.pubsub.v1.PushConfig push_config = 4;

Specified by:

getPushConfigOrBuilder in interface SubscriptionOrBuilder

getAckDeadlineSeconds

public int getAckDeadlineSeconds()

 This value is the maximum time after a subscriber receives a message
 before the subscriber should acknowledge the message. After message
 delivery but before the ack deadline expires and before the message is
 acknowledged, it is an outstanding message and will not be delivered
 again during that time (on a best-effort basis).
 For pull subscriptions, this value is used as the initial value for the ack
 deadline. To override this value for a given message, call
 `ModifyAckDeadline` with the corresponding `ack_id` if using
 pull.
 The minimum custom deadline you can specify is 10 seconds.
 The maximum custom deadline you can specify is 600 seconds (10 minutes).
 If this parameter is 0, a default value of 10 seconds is used.
 For push delivery, this value is also used to set the request timeout for
 the call to the push endpoint.
 If the subscriber never acknowledges the message, the Pub/Sub
 system will eventually redeliver the message.
 

int32 ack_deadline_seconds = 5;

Specified by:

getAckDeadlineSeconds in interface SubscriptionOrBuilder

getRetainAckedMessages

public boolean getRetainAckedMessages()

 Indicates whether to retain acknowledged messages. If true, then
 messages are not expunged from the subscription's backlog, even if they are
 acknowledged, until they fall out of the `message_retention_duration`
 window.
 

bool retain_acked_messages = 7;

Specified by:

getRetainAckedMessages in interface SubscriptionOrBuilder

hasMessageRetentionDuration

public boolean hasMessageRetentionDuration()

 How long to retain unacknowledged messages in the subscription's backlog,
 from the moment a message is published.
 If `retain_acked_messages` is true, then this also configures the retention
 of acknowledged messages, and thus configures how far back in time a `Seek`
 can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
 minutes.
 

.google.protobuf.Duration message_retention_duration = 8;

Specified by:

hasMessageRetentionDuration in interface SubscriptionOrBuilder

getMessageRetentionDuration

public Duration getMessageRetentionDuration()

 How long to retain unacknowledged messages in the subscription's backlog,
 from the moment a message is published.
 If `retain_acked_messages` is true, then this also configures the retention
 of acknowledged messages, and thus configures how far back in time a `Seek`
 can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
 minutes.
 

.google.protobuf.Duration message_retention_duration = 8;

Specified by:

getMessageRetentionDuration in interface SubscriptionOrBuilder

getMessageRetentionDurationOrBuilder

public DurationOrBuilder getMessageRetentionDurationOrBuilder()

 How long to retain unacknowledged messages in the subscription's backlog,
 from the moment a message is published.
 If `retain_acked_messages` is true, then this also configures the retention
 of acknowledged messages, and thus configures how far back in time a `Seek`
 can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
 minutes.
 

.google.protobuf.Duration message_retention_duration = 8;

Specified by:

getMessageRetentionDurationOrBuilder in interface SubscriptionOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: SubscriptionOrBuilder

 User labels.
 

map<string, string> labels = 9;

Specified by:

getLabelsCount in interface SubscriptionOrBuilder

containsLabels

public boolean containsLabels(java.lang.String key)

 User labels.
 

map<string, string> labels = 9;

Specified by:

containsLabels in interface SubscriptionOrBuilder

getLabels

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

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface SubscriptionOrBuilder

getLabelsMap

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

 User labels.
 

map<string, string> labels = 9;

Specified by:

getLabelsMap in interface SubscriptionOrBuilder

getLabelsOrDefault

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

 User labels.
 

map<string, string> labels = 9;

Specified by:

getLabelsOrDefault in interface SubscriptionOrBuilder

getLabelsOrThrow

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

 User labels.
 

map<string, string> labels = 9;

Specified by:

getLabelsOrThrow in interface SubscriptionOrBuilder

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 Subscription parseFrom(java.nio.ByteBuffer data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

public static Subscription parseFrom(ByteString data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public Subscription.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Subscription.Builder newBuilder()

newBuilder

public static Subscription.Builder newBuilder(Subscription prototype)

toBuilder

public Subscription.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Subscription.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Subscription getDefaultInstance()

parser

public static Parser<Subscription> parser()

getParserForType

public Parser<Subscription> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Subscription getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder