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

Subscription ackDeadlineSeconds.

deadLetterPolicy

Subscription deadLetterPolicy.

detached

Subscription detached.

enableMessageOrdering

Subscription enableMessageOrdering.

expirationPolicy

Subscription expirationPolicy.

filter

Subscription filter.

labels

Subscription labels.

messageRetentionDuration

Subscription messageRetentionDuration.

name

Subscription name.

pushConfig

Subscription pushConfig.

retainAckedMessages

Subscription retainAckedMessages.

retryPolicy

Subscription retryPolicy.

topic

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

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) 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

null if valid, otherwise the reason why it is not

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

Converts this Subscription to JSON.

Returns:
Type Description
Object.<string, *>

JSON object