com.google.pubsub.v1

Interface SubscriptionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Subscription, Subscription.Builder

public interface SubscriptionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(java.lang.String key) User labels.
int	getAckDeadlineSeconds() This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
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.
com.google.protobuf.Duration	getMessageRetentionDuration() How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
com.google.protobuf.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.
com.google.protobuf.ByteString	getNameBytes() The name of the subscription.
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.
java.lang.String	getTopic() The name of the topic from which this subscription is receiving messages.
com.google.protobuf.ByteString	getTopicBytes() The name of the topic from which this subscription is receiving messages.
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.

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

getNameBytes

com.google.protobuf.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;

getTopic

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;

getTopicBytes

com.google.protobuf.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;

hasPushConfig

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;

getPushConfig

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;

getPushConfigOrBuilder

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;

getAckDeadlineSeconds

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;

getRetainAckedMessages

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;

hasMessageRetentionDuration

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;

getMessageRetentionDuration

com.google.protobuf.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;

getMessageRetentionDurationOrBuilder

com.google.protobuf.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;

getLabelsCount

int getLabelsCount()

 User labels.
 

map<string, string> labels = 9;

containsLabels

boolean containsLabels(java.lang.String key)

 User labels.
 

map<string, string> labels = 9;

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

getLabelsOrDefault

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

 User labels.
 

map<string, string> labels = 9;

getLabelsOrThrow

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

 User labels.
 

map<string, string> labels = 9;