Subscription

final class Subscription extends GeneratedMessageV3 with 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

Source: Subscription.java

Linear Supertypes

SubscriptionOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Subscription
SubscriptionOrBuilder
GeneratedMessageV3
Serializable
AbstractMessage
Message
MessageOrBuilder
AbstractMessageLite
MessageLite
MessageLiteOrBuilder
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def containsLabels(key: String): Boolean
```
Optional. See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
```
```
Optional. See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
```
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(obj: AnyRef): Boolean
Definition Classes
Subscription → AbstractMessage → Message → AnyRef → Any
Annotations
@Override()
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
def findInitializationErrors(): List[String]
Definition Classes
AbstractMessage → MessageOrBuilder

def getAckDeadlineSeconds(): Int

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

returns: The ackDeadlineSeconds.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getAllFields(): Map[FieldDescriptor, AnyRef]
Definition Classes
GeneratedMessageV3 → MessageOrBuilder
def getBigqueryConfig(): BigQueryConfig
```
Optional. If delivery to BigQuery is used with this subscription, this
field is used to configure it.
```
```
Optional. If delivery to BigQuery is used with this subscription, this
field is used to configure it.
```
.google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
returns
The bigqueryConfig.
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()
def getBigqueryConfigOrBuilder(): BigQueryConfigOrBuilder
```
Optional. If delivery to BigQuery is used with this subscription, this
field is used to configure it.
```
```
Optional. If delivery to BigQuery is used with this subscription, this
field is used to configure it.
```
.google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def getCloudStorageConfig(): CloudStorageConfig
```
Optional. If delivery to Google Cloud Storage is used with this
subscription, this field is used to configure it.
```
```
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
returns
The cloudStorageConfig.
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()
def getCloudStorageConfigOrBuilder(): CloudStorageConfigOrBuilder
```
Optional. If delivery to Google Cloud Storage is used with this
subscription, this field is used to configure it.
```
```
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()

def getDeadLetterPolicy(): DeadLetterPolicy

Optional. 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 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.

Optional. 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 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 [(.google.api.field_behavior) = OPTIONAL];

returns: The deadLetterPolicy.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getDeadLetterPolicyOrBuilder(): DeadLetterPolicyOrBuilder

Optional. 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 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.

Optional. 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 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 [(.google.api.field_behavior) = OPTIONAL];

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getDefaultInstanceForType(): Subscription
Definition Classes
Subscription → MessageOrBuilder → MessageLiteOrBuilder
Annotations
@Override()
def getDescriptorForType(): Descriptor
Definition Classes
GeneratedMessageV3 → MessageOrBuilder

def getDetached(): Boolean

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

returns: The detached.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getEnableExactlyOnceDelivery(): Boolean

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

returns: The enableExactlyOnceDelivery.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getEnableMessageOrdering(): Boolean

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

returns: The enableMessageOrdering.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getExpirationPolicy(): ExpirationPolicy

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

returns: The expirationPolicy.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getExpirationPolicyOrBuilder(): ExpirationPolicyOrBuilder

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getField(arg0: FieldDescriptor): AnyRef
Definition Classes
GeneratedMessageV3 → MessageOrBuilder

def getFilter(): String

Optional. An expression written in the Pub/Sub [filter
language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
then only `PubsubMessage`s whose `attributes` field matches the filter are
delivered on this subscription. If empty, then no messages are filtered
out.

Optional. An expression written in the Pub/Sub [filter
language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
then only `PubsubMessage`s whose `attributes` field matches the filter are
delivered on this subscription. If empty, then no messages are filtered
out.

string filter = 12 [(.google.api.field_behavior) = OPTIONAL];

returns: The filter.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getFilterBytes(): ByteString

Optional. An expression written in the Pub/Sub [filter
language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
then only `PubsubMessage`s whose `attributes` field matches the filter are
delivered on this subscription. If empty, then no messages are filtered
out.

Optional. An expression written in the Pub/Sub [filter
language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
then only `PubsubMessage`s whose `attributes` field matches the filter are
delivered on this subscription. If empty, then no messages are filtered
out.

string filter = 12 [(.google.api.field_behavior) = OPTIONAL];

returns: The bytes for filter.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getInitializationErrorString(): String
Definition Classes
AbstractMessage → MessageOrBuilder

def getLabelsCount(): Int

Optional. See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).

Optional. See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Definition Classes: Subscription → SubscriptionOrBuilder

def getLabelsMap(): Map[String, String]
```
Optional. See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
```
```
Optional. See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
```
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()
def getLabelsOrDefault(key: String, defaultValue: String): String
```
Optional. See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
```
```
Optional. See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
```
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()
def getLabelsOrThrow(key: String): String
```
Optional. See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
```
```
Optional. See [Creating and managing
labels](https://cloud.google.com/pubsub/docs/labels).
```
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()

def getMessageRetentionDuration(): Duration

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

returns: The messageRetentionDuration.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getMessageRetentionDurationOrBuilder(): DurationOrBuilder

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getName(): String

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"`.

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: The name.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getNameBytes(): ByteString

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"`.

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: The bytes for name.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
Definition Classes
GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
def getParserForType(): Parser[Subscription]
Definition Classes
Subscription → GeneratedMessageV3 → Message → MessageLite
Annotations
@Override()
def getPushConfig(): PushConfig
```
Optional. If push delivery is used with this subscription, this field is
used to configure it.
```
```
Optional. If push delivery is used with this subscription, this field is
used to configure it.
```
.google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
returns
The pushConfig.
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()
def getPushConfigOrBuilder(): PushConfigOrBuilder
```
Optional. If push delivery is used with this subscription, this field is
used to configure it.
```
```
Optional. If push delivery is used with this subscription, this field is
used to configure it.
```
.google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()
def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
Definition Classes
GeneratedMessageV3 → MessageOrBuilder
def getRepeatedFieldCount(arg0: FieldDescriptor): Int
Definition Classes
GeneratedMessageV3 → MessageOrBuilder

def getRetainAckedMessages(): Boolean

Optional. 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]
(https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in
the past to replay previously-acknowledged messages.

Optional. 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]
(https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in
the past to replay previously-acknowledged messages.

bool retain_acked_messages = 7 [(.google.api.field_behavior) = OPTIONAL];

returns: The retainAckedMessages.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getRetryPolicy(): RetryPolicy

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

returns: The retryPolicy.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getRetryPolicyOrBuilder(): RetryPolicyOrBuilder

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getSerializedSize(): Int
Definition Classes
Subscription → GeneratedMessageV3 → AbstractMessage → MessageLite
Annotations
@Override()
def getState(): State
```
Output only. An output-only field indicating whether or not the
subscription can receive messages.
```
```
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
The state.
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()
def getStateValue(): Int
```
Output only. An output-only field indicating whether or not the
subscription can receive messages.
```
```
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
The enum numeric value on the wire for state.
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()

def getTopic(): String

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.

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: The topic.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getTopicBytes(): ByteString

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.

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: The bytes for topic.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getTopicMessageRetentionDuration(): Duration

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.

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: The topicMessageRetentionDuration.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getTopicMessageRetentionDurationOrBuilder(): DurationOrBuilder

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.

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

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def getUnknownFields(): UnknownFieldSet
Definition Classes
GeneratedMessageV3 → MessageOrBuilder
def hasBigqueryConfig(): Boolean
```
Optional. If delivery to BigQuery is used with this subscription, this
field is used to configure it.
```
```
Optional. If delivery to BigQuery is used with this subscription, this
field is used to configure it.
```
.google.pubsub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];
returns
Whether the bigqueryConfig field is set.
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()
def hasCloudStorageConfig(): Boolean
```
Optional. If delivery to Google Cloud Storage is used with this
subscription, this field is used to configure it.
```
```
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
returns
Whether the cloudStorageConfig field is set.
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()

def hasDeadLetterPolicy(): Boolean

Optional. 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 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.

Optional. 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 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 [(.google.api.field_behavior) = OPTIONAL];

returns: Whether the deadLetterPolicy field is set.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def hasExpirationPolicy(): Boolean

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

returns: Whether the expirationPolicy field is set.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def hasField(arg0: FieldDescriptor): Boolean
Definition Classes
GeneratedMessageV3 → MessageOrBuilder

def hasMessageRetentionDuration(): Boolean

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

returns: Whether the messageRetentionDuration field is set.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def hasOneof(arg0: OneofDescriptor): Boolean
Definition Classes
GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
def hasPushConfig(): Boolean
```
Optional. If push delivery is used with this subscription, this field is
used to configure it.
```
```
Optional. If push delivery is used with this subscription, this field is
used to configure it.
```
.google.pubsub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];
returns
Whether the pushConfig field is set.
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override()

def hasRetryPolicy(): Boolean

Optional. 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.

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

returns: Whether the retryPolicy field is set.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def hasTopicMessageRetentionDuration(): Boolean

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.

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: Whether the topicMessageRetentionDuration field is set.

Definition Classes: Subscription → SubscriptionOrBuilder
Annotations: @Override()

def hashCode(): Int
Definition Classes
Subscription → AbstractMessage → Message → AnyRef → Any
Annotations
@Override()
def internalGetFieldAccessorTable(): FieldAccessorTable
Attributes
protected[v1]
Definition Classes
Subscription → GeneratedMessageV3
Annotations
@Override()
def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
def internalGetMapFieldReflection(number: Int): MapFieldReflectionAccessor
Attributes
protected[v1]
Annotations
@SuppressWarnings() @Override()
final def isInitialized(): Boolean
Definition Classes
Subscription → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
Annotations
@Override()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def makeExtensionsImmutable(): Unit
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def newBuilderForType(parent: BuilderParent): Builder
Attributes
protected[v1]
Definition Classes
Subscription → GeneratedMessageV3
Annotations
@Override()
def newBuilderForType(): Builder
Definition Classes
Subscription → Message → MessageLite
Annotations
@Override()
def newBuilderForType(arg0: BuilderParent): Builder
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3 → AbstractMessage
def newInstance(unused: UnusedPrivateParameter): AnyRef
Attributes
protected[v1]
Definition Classes
Subscription → GeneratedMessageV3
Annotations
@Override() @SuppressWarnings()
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
Annotations
@throws(classOf[java.io.IOException])
def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
Annotations
@throws(classOf[java.io.IOException])
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toBuilder(): Builder
Definition Classes
Subscription → Message → MessageLite
Annotations
@Override()
def toByteArray(): Array[Byte]
Definition Classes
AbstractMessageLite → MessageLite
def toByteString(): ByteString
Definition Classes
AbstractMessageLite → MessageLite
final def toString(): String
Definition Classes
AbstractMessage → Message → AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
def writeDelimitedTo(arg0: OutputStream): Unit
Definition Classes
AbstractMessageLite → MessageLite
Annotations
@throws(classOf[java.io.IOException])
def writeReplace(): AnyRef
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
Annotations
@throws(classOf[java.io.ObjectStreamException])
def writeTo(output: CodedOutputStream): Unit
Definition Classes
Subscription → GeneratedMessageV3 → AbstractMessage → MessageLite
Annotations
@Override()
def writeTo(arg0: OutputStream): Unit
Definition Classes
AbstractMessageLite → MessageLite
Annotations
@throws(classOf[java.io.IOException])

Deprecated Value Members

def getLabels(): Map[String, String]
Use #getLabelsMap() instead.
Use #getLabelsMap() instead.
Definition Classes
Subscription → SubscriptionOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
Attributes
protected[protobuf]
Definition Classes
GeneratedMessageV3
Annotations
@throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
Deprecated

Packages

Subscription

final class Subscription extends GeneratedMessageV3 with SubscriptionOrBuilder

Value Members

Deprecated Value Members

Inherited from SubscriptionOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Subscription

final class Subscription extends GeneratedMessageV3 with SubscriptionOrBuilder

Value Members

Deprecated Value Members

Inherited from SubscriptionOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped

Subscription