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

Abstract Value Members

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

    User labels.


    User labels.

    map<string, string> labels = 9;

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

    This value is the maximum time after a subscriber receives a message
before the subscriber should acknowledge the message. After message
delivery but before the ack deadline expires and before the message is
acknowledged, it is an outstanding message and will not be delivered
again during that time (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
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.


    This value is the maximum time after a subscriber receives a message
before the subscriber should acknowledge the message. After message
delivery but before the ack deadline expires and before the message is
acknowledged, it is an outstanding message and will not be delivered
again during that time (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
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;

  4. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  5. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  6. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  7. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  8. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  9. abstract def getLabels(): Map[String, String]

    Use #getLabelsMap() instead.

  10. abstract def getLabelsCount(): Int 

    User labels.


    User labels.

    map<string, string> labels = 9;

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

    User labels.


    User labels.

    map<string, string> labels = 9;

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

    User labels.


    User labels.

    map<string, string> labels = 9;

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

    User labels.


    User labels.

    map<string, string> labels = 9;

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

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

  16. abstract def getName(): String 

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


    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;

  17. abstract def getNameBytes(): ByteString 

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


    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;

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

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

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


    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.

    bool retain_acked_messages = 7;

  24. abstract def getTopic(): String 

    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.


    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;

  25. abstract def getTopicBytes(): ByteString 

    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.


    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;

  26. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  27. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  28. 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;

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

  31. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder

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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    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( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped