Packages

c

com.google.pubsub.v1

Subscription

final class Subscription extends GeneratedMessageV3 with SubscriptionOrBuilder 

A subscription resource.

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
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Subscription
  2. SubscriptionOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def containsLabels(key: String): Boolean 

    User labels.


    User labels.

    map<string, string> labels = 9;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(obj: Any): Boolean
    Definition Classes
    Subscription → AbstractMessage → Message → AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  11. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  12. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getDefaultInstanceForType(): Subscription
    Definition Classes
    Subscription → MessageOrBuilder → MessageLiteOrBuilder
  15. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  16. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  17. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  18. def getLabels(): Map[String, String]

    Use #getLabelsMap() instead.

    Use #getLabelsMap() instead.

    Definition Classes
    Subscription → SubscriptionOrBuilder
  19. def getLabelsCount(): Int 

    User labels.


    User labels.

    map<string, string> labels = 9;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  20. def getLabelsMap(): Map[String, String] 

    User labels.


    User labels.

    map<string, string> labels = 9;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  21. def getLabelsOrDefault(key: String, defaultValue: String): String 

    User labels.


    User labels.

    map<string, string> labels = 9;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  22. def getLabelsOrThrow(key: String): String 

    User labels.


    User labels.

    map<string, string> labels = 9;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  23. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  24. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  25. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  26. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  27. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  28. def getParserForType(): Parser[Subscription]
    Definition Classes
    Subscription → GeneratedMessageV3 → Message → MessageLite
  29. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  30. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  31. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  32. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  33. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  34. def getSerializedSize(): Int
    Definition Classes
    Subscription → GeneratedMessageV3 → AbstractMessage → MessageLite
  35. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  36. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  37. final def getUnknownFields(): UnknownFieldSet
    Definition Classes
    Subscription → GeneratedMessageV3 → MessageOrBuilder
  38. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  39. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  40. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  41. 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;

    Definition Classes
    Subscription → SubscriptionOrBuilder
  42. def hashCode(): Int
    Definition Classes
    Subscription → AbstractMessage → Message → AnyRef → Any
  43. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[com.google.pubsub.v1]
    Definition Classes
    Subscription → GeneratedMessageV3
  44. def internalGetMapField(number: Int): MapField
    Attributes
    protected[com.google.pubsub.v1]
    Definition Classes
    Subscription → GeneratedMessageV3
  45. final def isInitialized(): Boolean
    Definition Classes
    Subscription → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
  46. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  47. def makeExtensionsImmutable(): Unit
    Attributes
    protected[com.google.protobuf]
    Definition Classes
    GeneratedMessageV3
  48. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[com.google.pubsub.v1]
    Definition Classes
    Subscription → GeneratedMessageV3
  50. def newBuilderForType(): Builder
    Definition Classes
    Subscription → Message → MessageLite
  51. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[com.google.protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  52. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  53. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  54. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[com.google.protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  55. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[com.google.protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  56. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  57. def toBuilder(): Builder
    Definition Classes
    Subscription → Message → MessageLite
  58. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  59. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  60. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  64. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )
  65. def writeReplace(): AnyRef
    Attributes
    protected[com.google.protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... )
  66. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    Subscription → GeneratedMessageV3 → AbstractMessage → MessageLite
  67. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )

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