Subscription

google.pubsub.v1. Subscription

Represents a Subscription.

Constructor

new Subscription(propertiesopt)

Constructs a new Subscription.

Parameters:
Name Type Attributes Description
properties google.pubsub.v1.ISubscription <optional>

Properties to set

Implements:
  • ISubscription

Members

ackDeadlineSeconds :number

Subscription ackDeadlineSeconds.

deadLetterPolicy :google.pubsub.v1.IDeadLetterPolicy|null|undefined

Subscription deadLetterPolicy.

detached :boolean

Subscription detached.

enableMessageOrdering :boolean

Subscription enableMessageOrdering.

expirationPolicy :google.pubsub.v1.IExpirationPolicy|null|undefined

Subscription expirationPolicy.

filter :string

Subscription filter.

labels :Object.<string, string>

Subscription labels.

messageRetentionDuration :google.protobuf.IDuration|null|undefined

Subscription messageRetentionDuration.

name :string

Subscription name.

pushConfig :google.pubsub.v1.IPushConfig|null|undefined

Subscription pushConfig.

retainAckedMessages :boolean

Subscription retainAckedMessages.

retryPolicy :google.pubsub.v1.IRetryPolicy|null|undefined

Subscription retryPolicy.

topic :string

Subscription topic.

Methods

(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

(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

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

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

(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

(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

(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

(static) verify(message) → {string|null}

Verifies a Subscription message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this Subscription to JSON.