public final class Subscription extends com.google.protobuf.GeneratedMessageV3 implements SubscriptionOrBuilder
A subscription resource.Protobuf type
google.pubsub.v1.Subscription
Modifier and Type | Class and Description |
---|---|
static class |
Subscription.Builder
A subscription resource.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
ACK_DEADLINE_SECONDS_FIELD_NUMBER |
static int |
ENABLE_MESSAGE_ORDERING_FIELD_NUMBER |
static int |
EXPIRATION_POLICY_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 |
Modifier and Type | Method and Description |
---|---|
boolean |
containsLabels(String key)
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.
|
boolean |
equals(Object obj) |
int |
getAckDeadlineSeconds()
The approximate amount of time (on a best-effort basis) Pub/Sub waits for
the subscriber to acknowledge receipt before resending the message.
|
static Subscription |
getDefaultInstance() |
Subscription |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getEnableMessageOrdering()
If true, messages published with the same `ordering_key` in `PubsubMessage`
will be delivered to the subscribers in the order in which they
are received by the Pub/Sub system.
|
ExpirationPolicy |
getExpirationPolicy()
A policy that specifies the conditions for this subscription's expiration.
|
ExpirationPolicyOrBuilder |
getExpirationPolicyOrBuilder()
A policy that specifies the conditions for this subscription's expiration.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.
|
Map<String,String> |
getLabelsMap()
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.
|
String |
getLabelsOrThrow(String key)
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.
|
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.
|
String |
getName()
The name of the subscription.
|
com.google.protobuf.ByteString |
getNameBytes()
The name of the subscription.
|
com.google.protobuf.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() |
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.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasExpirationPolicy()
A policy that specifies the conditions for this subscription's expiration.
|
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 com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static Subscription.Builder |
newBuilder() |
static Subscription.Builder |
newBuilder(Subscription prototype) |
Subscription.Builder |
newBuilderForType() |
protected Subscription.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static Subscription |
parseDelimitedFrom(InputStream input) |
static Subscription |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Subscription |
parseFrom(byte[] data) |
static Subscription |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Subscription |
parseFrom(ByteBuffer data) |
static Subscription |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Subscription |
parseFrom(com.google.protobuf.ByteString data) |
static Subscription |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Subscription |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Subscription |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Subscription |
parseFrom(InputStream input) |
static Subscription |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Subscription> |
parser() |
Subscription.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int NAME_FIELD_NUMBER
public static final int TOPIC_FIELD_NUMBER
public static final int PUSH_CONFIG_FIELD_NUMBER
public static final int ACK_DEADLINE_SECONDS_FIELD_NUMBER
public static final int RETAIN_ACKED_MESSAGES_FIELD_NUMBER
public static final int MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int ENABLE_MESSAGE_ORDERING_FIELD_NUMBER
public static final int EXPIRATION_POLICY_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField
in class com.google.protobuf.GeneratedMessageV3
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public 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;
getName
in interface SubscriptionOrBuilder
public 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;
getNameBytes
in interface SubscriptionOrBuilder
public 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;
getTopic
in interface SubscriptionOrBuilder
public 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;
getTopicBytes
in interface SubscriptionOrBuilder
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;
hasPushConfig
in interface SubscriptionOrBuilder
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;
getPushConfig
in interface SubscriptionOrBuilder
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;
getPushConfigOrBuilder
in interface SubscriptionOrBuilder
public int getAckDeadlineSeconds()
The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be <i>outstanding</i>. During that time period, the message will not be redelivered (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 non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming 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;
getAckDeadlineSeconds
in interface SubscriptionOrBuilder
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. This must be true if you would like to <a href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time"> Seek to a timestamp</a>.
bool retain_acked_messages = 7;
getRetainAckedMessages
in interface SubscriptionOrBuilder
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;
hasMessageRetentionDuration
in interface SubscriptionOrBuilder
public 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;
getMessageRetentionDuration
in interface SubscriptionOrBuilder
public 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;
getMessageRetentionDurationOrBuilder
in interface SubscriptionOrBuilder
public int getLabelsCount()
SubscriptionOrBuilder
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
map<string, string> labels = 9;
getLabelsCount
in interface SubscriptionOrBuilder
public boolean containsLabels(String key)
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
map<string, string> labels = 9;
containsLabels
in interface SubscriptionOrBuilder
@Deprecated public Map<String,String> getLabels()
getLabelsMap()
instead.getLabels
in interface SubscriptionOrBuilder
public Map<String,String> getLabelsMap()
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
map<string, string> labels = 9;
getLabelsMap
in interface SubscriptionOrBuilder
public String getLabelsOrDefault(String key, String defaultValue)
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
map<string, string> labels = 9;
getLabelsOrDefault
in interface SubscriptionOrBuilder
public String getLabelsOrThrow(String key)
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
map<string, string> labels = 9;
getLabelsOrThrow
in interface SubscriptionOrBuilder
public boolean getEnableMessageOrdering()
If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
bool enable_message_ordering = 10;
getEnableMessageOrdering
in interface SubscriptionOrBuilder
public boolean hasExpirationPolicy()
A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
hasExpirationPolicy
in interface SubscriptionOrBuilder
public ExpirationPolicy getExpirationPolicy()
A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
getExpirationPolicy
in interface SubscriptionOrBuilder
public ExpirationPolicyOrBuilder getExpirationPolicyOrBuilder()
A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
getExpirationPolicyOrBuilder
in interface SubscriptionOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static Subscription parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Subscription parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Subscription parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Subscription parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Subscription parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Subscription parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Subscription parseFrom(InputStream input) throws IOException
IOException
public static Subscription parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Subscription parseDelimitedFrom(InputStream input) throws IOException
IOException
public static Subscription parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Subscription parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static Subscription parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public Subscription.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static Subscription.Builder newBuilder()
public static Subscription.Builder newBuilder(Subscription prototype)
public Subscription.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected Subscription.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static Subscription getDefaultInstance()
public static com.google.protobuf.Parser<Subscription> parser()
public com.google.protobuf.Parser<Subscription> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public Subscription getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2019 Google LLC. All rights reserved.