Packages

t

com.google.pubsub.v1

SubscriptionOrBuilder

trait SubscriptionOrBuilder extends MessageOrBuilder

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SubscriptionOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def containsLabels(key: String): Boolean

    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.


    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.

    map<string, string> labels = 9;

  2. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  3. abstract def getAckDeadlineSeconds(): Int

    The approximate amount of time (on a best-effort basis) Pub/Sub waits for
the subscriber to acknowledge receipt before resending the message. In the
interval after the message is delivered and before it is acknowledged, it
is considered to be <i>outstanding</i>. During that time period, the
message will not be redelivered (on a best-effort basis).
For pull subscriptions, this value is used as the initial value for the ack
deadline. To override this value for a given message, call
`ModifyAckDeadline` with the corresponding `ack_id` if using
non-streaming pull or send the `ack_id` in a
`StreamingModifyAckDeadlineRequest` if using streaming pull.
The minimum custom deadline you can specify is 10 seconds.
The maximum custom deadline you can specify is 600 seconds (10 minutes).
If this parameter is 0, a default value of 10 seconds is used.
For push delivery, this value is also used to set the request timeout for
the call to the push endpoint.
If the subscriber never acknowledges the message, the Pub/Sub
system will eventually redeliver the message.


    The approximate amount of time (on a best-effort basis) Pub/Sub waits for
the subscriber to acknowledge receipt before resending the message. In the
interval after the message is delivered and before it is acknowledged, it
is considered to be <i>outstanding</i>. During that time period, the
message will not be redelivered (on a best-effort basis).
For pull subscriptions, this value is used as the initial value for the ack
deadline. To override this value for a given message, call
`ModifyAckDeadline` with the corresponding `ack_id` if using
non-streaming pull or send the `ack_id` in a
`StreamingModifyAckDeadlineRequest` if using streaming pull.
The minimum custom deadline you can specify is 10 seconds.
The maximum custom deadline you can specify is 600 seconds (10 minutes).
If this parameter is 0, a default value of 10 seconds is used.
For push delivery, this value is also used to set the request timeout for
the call to the push endpoint.
If the subscriber never acknowledges the message, the Pub/Sub
system will eventually redeliver the message.

    int32 ack_deadline_seconds = 5;

    returns

    The ackDeadlineSeconds.

  4. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  5. abstract def getDeadLetterPolicy(): DeadLetterPolicy

    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.


    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

    The deadLetterPolicy.

  6. abstract def getDeadLetterPolicyOrBuilder(): DeadLetterPolicyOrBuilder

    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.


    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;

  7. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  8. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  9. abstract def getDetached(): Boolean

    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.


    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

    The detached.

  10. abstract def getEnableMessageOrdering(): Boolean

    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.


    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

    The enableMessageOrdering.

  11. abstract def getExpirationPolicy(): ExpirationPolicy

    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.


    A policy that specifies the conditions for this subscription's expiration.
A subscription is considered active as long as any connected subscriber is
successfully consuming messages from the subscription or is issuing
operations on the subscription. If `expiration_policy` is not set, a
*default policy* with `ttl` of 31 days will be used. The minimum allowed
value for `expiration_policy.ttl` is 1 day.

    .google.pubsub.v1.ExpirationPolicy expiration_policy = 11;

    returns

    The expirationPolicy.

  12. abstract def getExpirationPolicyOrBuilder(): ExpirationPolicyOrBuilder

    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.


    A policy that specifies the conditions for this subscription's expiration.
A subscription is considered active as long as any connected subscriber is
successfully consuming messages from the subscription or is issuing
operations on the subscription. If `expiration_policy` is not set, a
*default policy* with `ttl` of 31 days will be used. The minimum allowed
value for `expiration_policy.ttl` is 1 day.

    .google.pubsub.v1.ExpirationPolicy expiration_policy = 11;

  13. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  14. abstract def getFilter(): String

    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.


    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;

    returns

    The filter.

  15. abstract def getFilterBytes(): ByteString

    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.


    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;

    returns

    The bytes for filter.

  16. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  17. abstract def getLabelsCount(): Int

    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.


    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.

    map<string, string> labels = 9;

  18. abstract def getLabelsMap(): Map[String, String]

    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.


    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.

    map<string, string> labels = 9;

  19. abstract def getLabelsOrDefault(key: String, defaultValue: String): String

    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.


    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.

    map<string, string> labels = 9;

  20. abstract def getLabelsOrThrow(key: String): String

    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.


    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.

    map<string, string> labels = 9;

  21. abstract def getMessageRetentionDuration(): Duration

    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.


    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

    The messageRetentionDuration.

  22. abstract def getMessageRetentionDurationOrBuilder(): DurationOrBuilder

    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.


    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;

  23. abstract 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.

  24. abstract 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.

  25. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  26. abstract def getPushConfig(): PushConfig

    If push delivery is used with this subscription, this field is
used to configure it. An empty `pushConfig` signifies that the subscriber
will pull and ack messages using API methods.


    If push delivery is used with this subscription, this field is
used to configure it. An empty `pushConfig` signifies that the subscriber
will pull and ack messages using API methods.

    .google.pubsub.v1.PushConfig push_config = 4;

    returns

    The pushConfig.

  27. abstract def getPushConfigOrBuilder(): PushConfigOrBuilder

    If push delivery is used with this subscription, this field is
used to configure it. An empty `pushConfig` signifies that the subscriber
will pull and ack messages using API methods.


    If push delivery is used with this subscription, this field is
used to configure it. An empty `pushConfig` signifies that the subscriber
will pull and ack messages using API methods.

    .google.pubsub.v1.PushConfig push_config = 4;

  28. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  29. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  30. abstract def getRetainAckedMessages(): Boolean

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


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

    bool retain_acked_messages = 7;

    returns

    The retainAckedMessages.

  31. abstract def getRetryPolicy(): RetryPolicy

    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.


    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

    The retryPolicy.

  32. abstract def getRetryPolicyOrBuilder(): RetryPolicyOrBuilder

    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.


    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;

  33. abstract 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.

  34. abstract 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.

  35. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  36. abstract def hasDeadLetterPolicy(): Boolean

    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.


    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

    Whether the deadLetterPolicy field is set.

  37. abstract def hasExpirationPolicy(): Boolean

    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.


    A policy that specifies the conditions for this subscription's expiration.
A subscription is considered active as long as any connected subscriber is
successfully consuming messages from the subscription or is issuing
operations on the subscription. If `expiration_policy` is not set, a
*default policy* with `ttl` of 31 days will be used. The minimum allowed
value for `expiration_policy.ttl` is 1 day.

    .google.pubsub.v1.ExpirationPolicy expiration_policy = 11;

    returns

    Whether the expirationPolicy field is set.

  38. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  39. abstract def hasMessageRetentionDuration(): Boolean

    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.


    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

    Whether the messageRetentionDuration field is set.

  40. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  41. abstract def hasPushConfig(): Boolean

    If push delivery is used with this subscription, this field is
used to configure it. An empty `pushConfig` signifies that the subscriber
will pull and ack messages using API methods.


    If push delivery is used with this subscription, this field is
used to configure it. An empty `pushConfig` signifies that the subscriber
will pull and ack messages using API methods.

    .google.pubsub.v1.PushConfig push_config = 4;

    returns

    Whether the pushConfig field is set.

  42. abstract def hasRetryPolicy(): Boolean

    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.


    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

    Whether the retryPolicy field is set.

  43. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder
  44. abstract def getLabels(): Map[String, String]

    Use #getLabelsMap() instead.

    Use #getLabelsMap() instead.

    Annotations
    @Deprecated
    Deprecated

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped