public final class Subscription extends GeneratedMessageV3 implements SubscriptionOrBuilder
A subscription resource.
Protobuf type google.pubsub.v1.Subscription
Static Fields
ACK_DEADLINE_SECONDS_FIELD_NUMBER
public static final int ACK_DEADLINE_SECONDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
BIGQUERY_CONFIG_FIELD_NUMBER
public static final int BIGQUERY_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DEAD_LETTER_POLICY_FIELD_NUMBER
public static final int DEAD_LETTER_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DETACHED_FIELD_NUMBER
public static final int DETACHED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER
public static final int ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENABLE_MESSAGE_ORDERING_FIELD_NUMBER
public static final int ENABLE_MESSAGE_ORDERING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXPIRATION_POLICY_FIELD_NUMBER
public static final int EXPIRATION_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public static final int MESSAGE_RETENTION_DURATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PUSH_CONFIG_FIELD_NUMBER
public static final int PUSH_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RETAIN_ACKED_MESSAGES_FIELD_NUMBER
public static final int RETAIN_ACKED_MESSAGES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RETRY_POLICY_FIELD_NUMBER
public static final int RETRY_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TOPIC_FIELD_NUMBER
public static final int TOPIC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TOPIC_MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public static final int TOPIC_MESSAGE_RETENTION_DURATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Subscription getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Subscription.Builder newBuilder()
newBuilder(Subscription prototype)
public static Subscription.Builder newBuilder(Subscription prototype)
public static Subscription parseDelimitedFrom(InputStream input)
public static Subscription parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Subscription parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Subscription parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Subscription parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Subscription parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Subscription parseFrom(CodedInputStream input)
public static Subscription parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Subscription parseFrom(InputStream input)
public static Subscription parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Subscription parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Subscription parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Subscription> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAckDeadlineSeconds()
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;
| Returns |
|---|
| Type | Description |
int | The ackDeadlineSeconds.
|
getBigqueryConfig()
public BigQueryConfig getBigqueryConfig()
If delivery to BigQuery is used with this subscription, this field is
used to configure it. Either pushConfig or bigQueryConfig can be set,
but not both. If both are empty, then the subscriber will pull and ack
messages using API methods.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
getBigqueryConfigOrBuilder()
public BigQueryConfigOrBuilder getBigqueryConfigOrBuilder()
If delivery to BigQuery is used with this subscription, this field is
used to configure it. Either pushConfig or bigQueryConfig can be set,
but not both. If both are empty, then the subscriber will pull and ack
messages using API methods.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
getDeadLetterPolicy()
public DeadLetterPolicy getDeadLetterPolicy()
A policy that specifies the conditions for dead lettering messages in
this subscription. If dead_letter_policy is not set, dead lettering
is disabled.
The Cloud Pub/Sub service account associated with this subscriptions's
parent project (i.e.,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
permission to Acknowledge() messages on this subscription.
.google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13;
getDeadLetterPolicyOrBuilder()
public DeadLetterPolicyOrBuilder getDeadLetterPolicyOrBuilder()
A policy that specifies the conditions for dead lettering messages in
this subscription. If dead_letter_policy is not set, dead lettering
is disabled.
The Cloud Pub/Sub service account associated with this subscriptions's
parent project (i.e.,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
permission to Acknowledge() messages on this subscription.
.google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13;
getDefaultInstanceForType()
public Subscription getDefaultInstanceForType()
getDetached()
public boolean getDetached()
Indicates whether the subscription is detached from its topic. Detached
subscriptions don't receive messages from their topic and don't retain any
backlog. Pull and StreamingPull requests will return
FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
the endpoint will not be made.
bool detached = 15;
| Returns |
|---|
| Type | Description |
boolean | The detached.
|
getEnableExactlyOnceDelivery()
public boolean getEnableExactlyOnceDelivery()
If true, Pub/Sub provides the following guarantees for the delivery of
a message with a given value of message_id on this subscription:
- The message sent to a subscriber is guaranteed not to be resent
before the message's acknowledgement deadline expires.
- An acknowledged message will not be resent to a subscriber.
Note that subscribers may still receive multiple copies of a message
when
enable_exactly_once_delivery is true if the message was published
multiple times by a publisher client. These copies are considered distinct
by Pub/Sub and have distinct message_id values.
bool enable_exactly_once_delivery = 16;
| Returns |
|---|
| Type | Description |
boolean | The enableExactlyOnceDelivery.
|
getEnableMessageOrdering()
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.
bool enable_message_ordering = 10;
| Returns |
|---|
| Type | Description |
boolean | The enableMessageOrdering.
|
getExpirationPolicy()
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;
getExpirationPolicyOrBuilder()
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;
getFilter()
public String getFilter()
An expression written in the Pub/Sub filter
language. If non-empty,
then only PubsubMessages whose attributes field matches the filter are
delivered on this subscription. If empty, then no messages are filtered
out.
string filter = 12;
| Returns |
|---|
| Type | Description |
String | The filter.
|
getFilterBytes()
public ByteString getFilterBytes()
An expression written in the Pub/Sub filter
language. If non-empty,
then only PubsubMessages whose attributes field matches the filter are
delivered on this subscription. If empty, then no messages are filtered
out.
string filter = 12;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for filter.
|
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
| Parameter |
|---|
| Name | Description |
key | String
|
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;
| Returns |
|---|
| Type | Description |
Duration | The messageRetentionDuration.
|
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;
getName()
Required. 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 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. 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 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Subscription> getParserForType()
Overrides
getPushConfig()
public PushConfig getPushConfig()
If push delivery is used with this subscription, this field is
used to configure it. Either pushConfig or bigQueryConfig can be set,
but not both. If both are empty, then the subscriber will pull and ack
messages using API methods.
.google.pubsub.v1.PushConfig push_config = 4;
getPushConfigOrBuilder()
public PushConfigOrBuilder getPushConfigOrBuilder()
If push delivery is used with this subscription, this field is
used to configure it. Either pushConfig or bigQueryConfig can be set,
but not both. If both are empty, then the subscriber will pull and ack
messages using API methods.
.google.pubsub.v1.PushConfig push_config = 4;
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. This must be true if you would like to Seek to a timestamp in
the past to replay previously-acknowledged messages.
bool retain_acked_messages = 7;
| Returns |
|---|
| Type | Description |
boolean | The retainAckedMessages.
|
getRetryPolicy()
public RetryPolicy getRetryPolicy()
A policy that specifies how Pub/Sub retries message delivery for this
subscription.
If not set, the default retry policy is applied. This generally implies
that messages will be retried as soon as possible for healthy subscribers.
RetryPolicy will be triggered on NACKs or acknowledgement deadline
exceeded events for a given message.
.google.pubsub.v1.RetryPolicy retry_policy = 14;
getRetryPolicyOrBuilder()
public RetryPolicyOrBuilder getRetryPolicyOrBuilder()
A policy that specifies how Pub/Sub retries message delivery for this
subscription.
If not set, the default retry policy is applied. This generally implies
that messages will be retried as soon as possible for healthy subscribers.
RetryPolicy will be triggered on NACKs or acknowledgement deadline
exceeded events for a given message.
.google.pubsub.v1.RetryPolicy retry_policy = 14;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getState()
public Subscription.State getState()
Output only. An output-only field indicating whether or not the
subscription can receive messages.
.google.pubsub.v1.Subscription.State state = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. An output-only field indicating whether or not the
subscription can receive messages.
.google.pubsub.v1.Subscription.State state = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
getTopic()
Required. 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 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The topic.
|
getTopicBytes()
public ByteString getTopicBytes()
Required. 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 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for topic.
|
getTopicMessageRetentionDuration()
public Duration getTopicMessageRetentionDuration()
Output only. Indicates the minimum duration for which a message is retained
after it is published to the subscription's topic. If this field is set,
messages published to the subscription's topic in the last
topic_message_retention_duration are always available to subscribers. See
the message_retention_duration field in Topic. This field is set only
in responses from the server; it is ignored if it is set in any requests.
.google.protobuf.Duration topic_message_retention_duration = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Duration | The topicMessageRetentionDuration.
|
getTopicMessageRetentionDurationOrBuilder()
public DurationOrBuilder getTopicMessageRetentionDurationOrBuilder()
Output only. Indicates the minimum duration for which a message is retained
after it is published to the subscription's topic. If this field is set,
messages published to the subscription's topic in the last
topic_message_retention_duration are always available to subscribers. See
the message_retention_duration field in Topic. This field is set only
in responses from the server; it is ignored if it is set in any requests.
.google.protobuf.Duration topic_message_retention_duration = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasBigqueryConfig()
public boolean hasBigqueryConfig()
If delivery to BigQuery is used with this subscription, this field is
used to configure it. Either pushConfig or bigQueryConfig can be set,
but not both. If both are empty, then the subscriber will pull and ack
messages using API methods.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
| Returns |
|---|
| Type | Description |
boolean | Whether the bigqueryConfig field is set.
|
hasDeadLetterPolicy()
public boolean hasDeadLetterPolicy()
A policy that specifies the conditions for dead lettering messages in
this subscription. If dead_letter_policy is not set, dead lettering
is disabled.
The Cloud Pub/Sub service account associated with this subscriptions's
parent project (i.e.,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
permission to Acknowledge() messages on this subscription.
.google.pubsub.v1.DeadLetterPolicy dead_letter_policy = 13;
| Returns |
|---|
| Type | Description |
boolean | Whether the deadLetterPolicy field is set.
|
hasExpirationPolicy()
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the expirationPolicy field is set.
|
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the messageRetentionDuration field is set.
|
hasPushConfig()
public boolean hasPushConfig()
If push delivery is used with this subscription, this field is
used to configure it. Either pushConfig or bigQueryConfig can be set,
but not both. If both are empty, then the subscriber will pull and ack
messages using API methods.
.google.pubsub.v1.PushConfig push_config = 4;
| Returns |
|---|
| Type | Description |
boolean | Whether the pushConfig field is set.
|
hasRetryPolicy()
public boolean hasRetryPolicy()
A policy that specifies how Pub/Sub retries message delivery for this
subscription.
If not set, the default retry policy is applied. This generally implies
that messages will be retried as soon as possible for healthy subscribers.
RetryPolicy will be triggered on NACKs or acknowledgement deadline
exceeded events for a given message.
.google.pubsub.v1.RetryPolicy retry_policy = 14;
| Returns |
|---|
| Type | Description |
boolean | Whether the retryPolicy field is set.
|
hasTopicMessageRetentionDuration()
public boolean hasTopicMessageRetentionDuration()
Output only. Indicates the minimum duration for which a message is retained
after it is published to the subscription's topic. If this field is set,
messages published to the subscription's topic in the last
topic_message_retention_duration are always available to subscribers. See
the message_retention_duration field in Topic. This field is set only
in responses from the server; it is ignored if it is set in any requests.
.google.protobuf.Duration topic_message_retention_duration = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the topicMessageRetentionDuration field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Subscription.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Subscription.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Subscription.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
