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

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

  2. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  3. abstract 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.

  4. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  5. abstract 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.

  6. abstract 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];

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

  8. abstract 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];

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

  10. abstract 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];

  11. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  12. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  13. abstract 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.

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

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

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

  17. abstract 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];

  18. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  19. abstract 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.

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

  21. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  22. abstract 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];

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

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

  25. abstract 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];

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

  27. abstract 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];

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

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

  30. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  31. abstract 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.

  32. abstract 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];

  33. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  34. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  35. abstract 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.

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

  37. abstract 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];

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

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

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

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

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

  43. abstract 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];

  44. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  45. abstract 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.

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

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

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

  49. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  50. abstract 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.

  51. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  52. abstract 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.

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

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

  55. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder
  56. 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