final class Subscription extends GeneratedMessageV3 with SubscriptionOrBuilder
A subscription resource.
Protobuf type google.pubsub.v1.Subscription
- Source
- Subscription.java
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- Subscription
- SubscriptionOrBuilder
- GeneratedMessageV3
- Serializable
- AbstractMessage
- Message
- MessageOrBuilder
- AbstractMessageLite
- MessageLite
- MessageLiteOrBuilder
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
containsLabels(key: String): Boolean
User labels.
User labels.
map<string, string> labels = 9;
- Definition Classes
- Subscription → SubscriptionOrBuilder
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(obj: Any): Boolean
- Definition Classes
- Subscription → AbstractMessage → Message → AnyRef → Any
-
def
findInitializationErrors(): List[String]
- Definition Classes
- AbstractMessage → MessageOrBuilder
-
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
-
def
getAllFields(): Map[FieldDescriptor, AnyRef]
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getDefaultInstanceForType(): Subscription
- Definition Classes
- Subscription → MessageOrBuilder → MessageLiteOrBuilder
-
def
getDescriptorForType(): Descriptor
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getField(arg0: FieldDescriptor): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getInitializationErrorString(): String
- Definition Classes
- AbstractMessage → MessageOrBuilder
-
def
getLabels(): Map[String, String]
Use
#getLabelsMap()
instead.Use
#getLabelsMap()
instead.- Definition Classes
- Subscription → SubscriptionOrBuilder
-
def
getLabelsCount(): Int
User labels.
User labels.
map<string, string> labels = 9;
- Definition Classes
- Subscription → SubscriptionOrBuilder
-
def
getLabelsMap(): Map[String, String]
User labels.
User labels.
map<string, string> labels = 9;
- Definition Classes
- Subscription → SubscriptionOrBuilder
-
def
getLabelsOrDefault(key: String, defaultValue: String): String
User labels.
User labels.
map<string, string> labels = 9;
- Definition Classes
- Subscription → SubscriptionOrBuilder
-
def
getLabelsOrThrow(key: String): String
User labels.
User labels.
map<string, string> labels = 9;
- Definition Classes
- Subscription → SubscriptionOrBuilder
-
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
-
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
-
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
-
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
-
def
getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
-
def
getParserForType(): Parser[Subscription]
- Definition Classes
- Subscription → GeneratedMessageV3 → Message → MessageLite
-
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
-
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
-
def
getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getRepeatedFieldCount(arg0: FieldDescriptor): Int
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
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
-
def
getSerializedSize(): Int
- Definition Classes
- Subscription → GeneratedMessageV3 → AbstractMessage → MessageLite
-
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
-
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
-
final
def
getUnknownFields(): UnknownFieldSet
- Definition Classes
- Subscription → GeneratedMessageV3 → MessageOrBuilder
-
def
hasField(arg0: FieldDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
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
-
def
hasOneof(arg0: OneofDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
-
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
-
def
hashCode(): Int
- Definition Classes
- Subscription → AbstractMessage → Message → AnyRef → Any
-
def
internalGetFieldAccessorTable(): FieldAccessorTable
- Attributes
- protected[com.google.pubsub.v1]
- Definition Classes
- Subscription → GeneratedMessageV3
-
def
internalGetMapField(number: Int): MapField
- Attributes
- protected[com.google.pubsub.v1]
- Definition Classes
- Subscription → GeneratedMessageV3
-
final
def
isInitialized(): Boolean
- Definition Classes
- Subscription → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
makeExtensionsImmutable(): Unit
- Attributes
- protected[com.google.protobuf]
- Definition Classes
- GeneratedMessageV3
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
newBuilderForType(parent: BuilderParent): Builder
- Attributes
- protected[com.google.pubsub.v1]
- Definition Classes
- Subscription → GeneratedMessageV3
-
def
newBuilderForType(): Builder
- Definition Classes
- Subscription → Message → MessageLite
-
def
newBuilderForType(arg0: BuilderParent): Builder
- Attributes
- protected[com.google.protobuf]
- Definition Classes
- GeneratedMessageV3 → AbstractMessage
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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] )
-
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] )
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toBuilder(): Builder
- Definition Classes
- Subscription → Message → MessageLite
-
def
toByteArray(): Array[Byte]
- Definition Classes
- AbstractMessageLite → MessageLite
-
def
toByteString(): ByteString
- Definition Classes
- AbstractMessageLite → MessageLite
-
final
def
toString(): String
- Definition Classes
- AbstractMessage → Message → AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
writeDelimitedTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws( classOf[java.io.IOException] )
-
def
writeReplace(): AnyRef
- Attributes
- protected[com.google.protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws( ... )
-
def
writeTo(output: CodedOutputStream): Unit
- Definition Classes
- Subscription → GeneratedMessageV3 → AbstractMessage → MessageLite
-
def
writeTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws( classOf[java.io.IOException] )