Constructor
new Subscription(propertiesopt)
Constructs a new Subscription.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.pubsub.v1.ISubscription |
<optional> |
Properties to set |
- Implements:
-
- ISubscription
Classes
Members
ackDeadlineSeconds
Subscription ackDeadlineSeconds.
analyticsHubSubscriptionInfo
Subscription analyticsHubSubscriptionInfo.
bigqueryConfig
Subscription bigqueryConfig.
cloudStorageConfig
Subscription cloudStorageConfig.
deadLetterPolicy
Subscription deadLetterPolicy.
detached
Subscription detached.
enableExactlyOnceDelivery
Subscription enableExactlyOnceDelivery.
enableMessageOrdering
Subscription enableMessageOrdering.
expirationPolicy
Subscription expirationPolicy.
filter
Subscription filter.
labels
Subscription labels.
messageRetentionDuration
Subscription messageRetentionDuration.
messageTransforms
Subscription messageTransforms.
name
Subscription name.
pushConfig
Subscription pushConfig.
retainAckedMessages
Subscription retainAckedMessages.
retryPolicy
Subscription retryPolicy.
state
Subscription state.
topic
Subscription topic.
topicMessageRetentionDuration
Subscription topicMessageRetentionDuration.
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
ACTIVE |
number |
ACTIVE value |
RESOURCE_ERROR |
number |
RESOURCE_ERROR value |
Methods
toJSON() → {Object.<string, *>}
Converts this Subscription to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.pubsub.v1.Subscription}
Creates a new Subscription instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.pubsub.v1.ISubscription |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.pubsub.v1.Subscription |
Subscription instance |
(static) decode(reader, lengthopt) → {google.pubsub.v1.Subscription}
Decodes a Subscription message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.pubsub.v1.Subscription |
Subscription |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.pubsub.v1.Subscription}
Decodes a Subscription message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.pubsub.v1.Subscription |
Subscription |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Subscription message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.pubsub.v1.ISubscription |
Subscription message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Subscription message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.pubsub.v1.ISubscription |
Subscription message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.pubsub.v1.Subscription}
Creates a Subscription message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.pubsub.v1.Subscription |
Subscription |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Subscription
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Subscription message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.pubsub.v1.Subscription |
Subscription |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Subscription message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|