public static final class Subscription.Builder extends GeneratedMessageV3.Builder<Subscription.Builder> implements SubscriptionOrBuilder A subscription resource. If none of push_config, bigquery_config, or
cloud_storage_config is set, then the subscriber will pull and ack messages
using API methods. At most one of these fields may be set.
Protobuf type google.pubsub.v1.Subscription
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Subscription.BuilderImplements
SubscriptionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Subscription.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
build()
public Subscription build()| Returns | |
|---|---|
| Type | Description |
Subscription | |
buildPartial()
public Subscription buildPartial()| Returns | |
|---|---|
| Type | Description |
Subscription | |
clear()
public Subscription.Builder clear()| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
clearAckDeadlineSeconds()
public Subscription.Builder clearAckDeadlineSeconds()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 outstanding. 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 |
Subscription.Builder | This builder for chaining. |
clearBigqueryConfig()
public Subscription.Builder clearBigqueryConfig()If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
clearCloudStorageConfig()
public Subscription.Builder clearCloudStorageConfig()If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
clearDeadLetterPolicy()
public Subscription.Builder clearDeadLetterPolicy()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 |
Subscription.Builder | |
clearDetached()
public Subscription.Builder clearDetached() 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 |
Subscription.Builder | This builder for chaining. |
clearEnableExactlyOnceDelivery()
public Subscription.Builder clearEnableExactlyOnceDelivery() 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_deliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_idvalues.
bool enable_exactly_once_delivery = 16;
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
clearEnableMessageOrdering()
public Subscription.Builder clearEnableMessageOrdering() 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 |
Subscription.Builder | This builder for chaining. |
clearExpirationPolicy()
public Subscription.Builder clearExpirationPolicy() 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. If expiration_policy is set,
but expiration_policy.ttl is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
clearField(Descriptors.FieldDescriptor field)
public Subscription.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
clearFilter()
public Subscription.Builder clearFilter() 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 |
Subscription.Builder | This builder for chaining. |
clearLabels()
public Subscription.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
clearMessageRetentionDuration()
public Subscription.Builder clearMessageRetentionDuration() 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 |
Subscription.Builder | |
clearName()
public Subscription.Builder clearName() 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 |
Subscription.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Subscription.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
clearPushConfig()
public Subscription.Builder clearPushConfig()If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
clearRetainAckedMessages()
public Subscription.Builder clearRetainAckedMessages() 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 |
Subscription.Builder | This builder for chaining. |
clearRetryPolicy()
public Subscription.Builder clearRetryPolicy()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 |
Subscription.Builder | |
clearState()
public Subscription.Builder clearState()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 |
Subscription.Builder | This builder for chaining. |
clearTopic()
public Subscription.Builder clearTopic() 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 |
Subscription.Builder | This builder for chaining. |
clearTopicMessageRetentionDuration()
public Subscription.Builder clearTopicMessageRetentionDuration() 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 |
Subscription.Builder | |
clone()
public Subscription.Builder clone()| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
containsLabels(String key)
public boolean containsLabels(String key)See Creating and managing labels.
map<string, string> labels = 9;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
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 outstanding. 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.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig | The bigqueryConfig. |
getBigqueryConfigBuilder()
public BigQueryConfig.Builder getBigqueryConfigBuilder()If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig.Builder | |
getBigqueryConfigOrBuilder()
public BigQueryConfigOrBuilder getBigqueryConfigOrBuilder()If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
| Returns | |
|---|---|
| Type | Description |
BigQueryConfigOrBuilder | |
getCloudStorageConfig()
public CloudStorageConfig getCloudStorageConfig()If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig | The cloudStorageConfig. |
getCloudStorageConfigBuilder()
public CloudStorageConfig.Builder getCloudStorageConfigBuilder()If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig.Builder | |
getCloudStorageConfigOrBuilder()
public CloudStorageConfigOrBuilder getCloudStorageConfigOrBuilder()If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfigOrBuilder | |
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;
| Returns | |
|---|---|
| Type | Description |
DeadLetterPolicy | The deadLetterPolicy. |
getDeadLetterPolicyBuilder()
public DeadLetterPolicy.Builder getDeadLetterPolicyBuilder()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 |
DeadLetterPolicy.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
DeadLetterPolicyOrBuilder | |
getDefaultInstanceForType()
public Subscription getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Subscription | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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_deliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_idvalues.
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. If expiration_policy is set,
but expiration_policy.ttl is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
| Returns | |
|---|---|
| Type | Description |
ExpirationPolicy | The expirationPolicy. |
getExpirationPolicyBuilder()
public ExpirationPolicy.Builder getExpirationPolicyBuilder() 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. If expiration_policy is set,
but expiration_policy.ttl is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
| Returns | |
|---|---|
| Type | Description |
ExpirationPolicy.Builder | |
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. If expiration_policy is set,
but expiration_policy.ttl is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
| Returns | |
|---|---|
| Type | Description |
ExpirationPolicyOrBuilder | |
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()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public int getLabelsCount()See Creating and managing labels.
map<string, string> labels = 9;
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()See Creating and managing labels.
map<string, string> labels = 9;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)See Creating and managing labels.
map<string, string> labels = 9;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)See Creating and managing labels.
map<string, string> labels = 9;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
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. |
getMessageRetentionDurationBuilder()
public Duration.Builder getMessageRetentionDurationBuilder() 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 |
Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder | |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getName()
public String 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. |
getPushConfig()
public PushConfig getPushConfig()If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
| Returns | |
|---|---|
| Type | Description |
PushConfig | The pushConfig. |
getPushConfigBuilder()
public PushConfig.Builder getPushConfigBuilder()If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder | |
getPushConfigOrBuilder()
public PushConfigOrBuilder getPushConfigOrBuilder()If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
| Returns | |
|---|---|
| Type | Description |
PushConfigOrBuilder | |
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;
| Returns | |
|---|---|
| Type | Description |
RetryPolicy | The retryPolicy. |
getRetryPolicyBuilder()
public RetryPolicy.Builder getRetryPolicyBuilder()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 |
RetryPolicy.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
RetryPolicyOrBuilder | |
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];
| Returns | |
|---|---|
| Type | Description |
Subscription.State | The state. |
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()
public String 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. |
getTopicMessageRetentionDurationBuilder()
public Duration.Builder getTopicMessageRetentionDurationBuilder() 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 |
Builder | |
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];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder | |
hasBigqueryConfig()
public boolean hasBigqueryConfig()If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the bigqueryConfig field is set. |
hasCloudStorageConfig()
public boolean hasCloudStorageConfig()If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the cloudStorageConfig 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. If expiration_policy is set,
but expiration_policy.ttl is not set, the subscription never expires.
.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.
.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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeBigqueryConfig(BigQueryConfig value)
public Subscription.Builder mergeBigqueryConfig(BigQueryConfig value)If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
| Parameter | |
|---|---|
| Name | Description |
value | BigQueryConfig |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
mergeCloudStorageConfig(CloudStorageConfig value)
public Subscription.Builder mergeCloudStorageConfig(CloudStorageConfig value)If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
| Parameter | |
|---|---|
| Name | Description |
value | CloudStorageConfig |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
mergeDeadLetterPolicy(DeadLetterPolicy value)
public Subscription.Builder mergeDeadLetterPolicy(DeadLetterPolicy value)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;
| Parameter | |
|---|---|
| Name | Description |
value | DeadLetterPolicy |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
mergeExpirationPolicy(ExpirationPolicy value)
public Subscription.Builder mergeExpirationPolicy(ExpirationPolicy value) 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. If expiration_policy is set,
but expiration_policy.ttl is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
| Parameter | |
|---|---|
| Name | Description |
value | ExpirationPolicy |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Subscription.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Subscription.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
mergeFrom(Subscription other)
public Subscription.Builder mergeFrom(Subscription other)| Parameter | |
|---|---|
| Name | Description |
other | Subscription |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
mergeMessageRetentionDuration(Duration value)
public Subscription.Builder mergeMessageRetentionDuration(Duration value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
mergePushConfig(PushConfig value)
public Subscription.Builder mergePushConfig(PushConfig value)If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
| Parameter | |
|---|---|
| Name | Description |
value | PushConfig |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
mergeRetryPolicy(RetryPolicy value)
public Subscription.Builder mergeRetryPolicy(RetryPolicy value)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;
| Parameter | |
|---|---|
| Name | Description |
value | RetryPolicy |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
mergeTopicMessageRetentionDuration(Duration value)
public Subscription.Builder mergeTopicMessageRetentionDuration(Duration value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Subscription.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
putAllLabels(Map<String,String> values)
public Subscription.Builder putAllLabels(Map<String,String> values)See Creating and managing labels.
map<string, string> labels = 9;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
putLabels(String key, String value)
public Subscription.Builder putLabels(String key, String value)See Creating and managing labels.
map<string, string> labels = 9;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
removeLabels(String key)
public Subscription.Builder removeLabels(String key)See Creating and managing labels.
map<string, string> labels = 9;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setAckDeadlineSeconds(int value)
public Subscription.Builder setAckDeadlineSeconds(int value)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 outstanding. 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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe ackDeadlineSeconds to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setBigqueryConfig(BigQueryConfig value)
public Subscription.Builder setBigqueryConfig(BigQueryConfig value)If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
| Parameter | |
|---|---|
| Name | Description |
value | BigQueryConfig |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setBigqueryConfig(BigQueryConfig.Builder builderForValue)
public Subscription.Builder setBigqueryConfig(BigQueryConfig.Builder builderForValue)If delivery to BigQuery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.BigQueryConfig bigquery_config = 18;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | BigQueryConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setCloudStorageConfig(CloudStorageConfig value)
public Subscription.Builder setCloudStorageConfig(CloudStorageConfig value)If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
| Parameter | |
|---|---|
| Name | Description |
value | CloudStorageConfig |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setCloudStorageConfig(CloudStorageConfig.Builder builderForValue)
public Subscription.Builder setCloudStorageConfig(CloudStorageConfig.Builder builderForValue)If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | CloudStorageConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setDeadLetterPolicy(DeadLetterPolicy value)
public Subscription.Builder setDeadLetterPolicy(DeadLetterPolicy value)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;
| Parameter | |
|---|---|
| Name | Description |
value | DeadLetterPolicy |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setDeadLetterPolicy(DeadLetterPolicy.Builder builderForValue)
public Subscription.Builder setDeadLetterPolicy(DeadLetterPolicy.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | DeadLetterPolicy.Builder |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setDetached(boolean value)
public Subscription.Builder setDetached(boolean value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe detached to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setEnableExactlyOnceDelivery(boolean value)
public Subscription.Builder setEnableExactlyOnceDelivery(boolean value) 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_deliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_idvalues.
bool enable_exactly_once_delivery = 16;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe enableExactlyOnceDelivery to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setEnableMessageOrdering(boolean value)
public Subscription.Builder setEnableMessageOrdering(boolean value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe enableMessageOrdering to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setExpirationPolicy(ExpirationPolicy value)
public Subscription.Builder setExpirationPolicy(ExpirationPolicy value) 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. If expiration_policy is set,
but expiration_policy.ttl is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
| Parameter | |
|---|---|
| Name | Description |
value | ExpirationPolicy |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setExpirationPolicy(ExpirationPolicy.Builder builderForValue)
public Subscription.Builder setExpirationPolicy(ExpirationPolicy.Builder builderForValue) 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. If expiration_policy is set,
but expiration_policy.ttl is not set, the subscription never expires.
.google.pubsub.v1.ExpirationPolicy expiration_policy = 11;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ExpirationPolicy.Builder |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public Subscription.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setFilter(String value)
public Subscription.Builder setFilter(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public Subscription.Builder setFilterBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setMessageRetentionDuration(Duration value)
public Subscription.Builder setMessageRetentionDuration(Duration value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setMessageRetentionDuration(Duration.Builder builderForValue)
public Subscription.Builder setMessageRetentionDuration(Duration.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setName(String value)
public Subscription.Builder setName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Subscription.Builder setNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setPushConfig(PushConfig value)
public Subscription.Builder setPushConfig(PushConfig value)If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
| Parameter | |
|---|---|
| Name | Description |
value | PushConfig |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setPushConfig(PushConfig.Builder builderForValue)
public Subscription.Builder setPushConfig(PushConfig.Builder builderForValue)If push delivery is used with this subscription, this field is used to configure it.
.google.pubsub.v1.PushConfig push_config = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | PushConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Subscription.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setRetainAckedMessages(boolean value)
public Subscription.Builder setRetainAckedMessages(boolean value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe retainAckedMessages to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setRetryPolicy(RetryPolicy value)
public Subscription.Builder setRetryPolicy(RetryPolicy value)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;
| Parameter | |
|---|---|
| Name | Description |
value | RetryPolicy |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setRetryPolicy(RetryPolicy.Builder builderForValue)
public Subscription.Builder setRetryPolicy(RetryPolicy.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | RetryPolicy.Builder |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setState(Subscription.State value)
public Subscription.Builder setState(Subscription.State value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Subscription.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setStateValue(int value)
public Subscription.Builder setStateValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setTopic(String value)
public Subscription.Builder setTopic(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe topic to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setTopicBytes(ByteString value)
public Subscription.Builder setTopicBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for topic to set. |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | This builder for chaining. |
setTopicMessageRetentionDuration(Duration value)
public Subscription.Builder setTopicMessageRetentionDuration(Duration value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setTopicMessageRetentionDuration(Duration.Builder builderForValue)
public Subscription.Builder setTopicMessageRetentionDuration(Duration.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Subscription.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Subscription.Builder | |