Represents a Subscription.
Package
@google-cloud/pubsubConstructors
(constructor)(properties)
constructor(properties?: google.pubsub.v1.ISubscription);
Constructs a new Subscription.
Parameter | |
---|---|
Name | Description |
properties |
ISubscription
Properties to set |
Properties
ackDeadlineSeconds
public ackDeadlineSeconds: number;
Subscription ackDeadlineSeconds.
bigqueryConfig
public bigqueryConfig?: (google.pubsub.v1.IBigQueryConfig|null);
Subscription bigqueryConfig.
cloudStorageConfig
public cloudStorageConfig?: (google.pubsub.v1.ICloudStorageConfig|null);
Subscription cloudStorageConfig.
deadLetterPolicy
public deadLetterPolicy?: (google.pubsub.v1.IDeadLetterPolicy|null);
Subscription deadLetterPolicy.
detached
public detached: boolean;
Subscription detached.
enableExactlyOnceDelivery
public enableExactlyOnceDelivery: boolean;
Subscription enableExactlyOnceDelivery.
enableMessageOrdering
public enableMessageOrdering: boolean;
Subscription enableMessageOrdering.
expirationPolicy
public expirationPolicy?: (google.pubsub.v1.IExpirationPolicy|null);
Subscription expirationPolicy.
filter
public filter: string;
Subscription filter.
labels
public labels: { [k: string]: string };
Subscription labels.
messageRetentionDuration
public messageRetentionDuration?: (google.protobuf.IDuration|null);
Subscription messageRetentionDuration.
name
public name: string;
Subscription name.
pushConfig
public pushConfig?: (google.pubsub.v1.IPushConfig|null);
Subscription pushConfig.
retainAckedMessages
public retainAckedMessages: boolean;
Subscription retainAckedMessages.
retryPolicy
public retryPolicy?: (google.pubsub.v1.IRetryPolicy|null);
Subscription retryPolicy.
state
public state: (google.pubsub.v1.Subscription.State|keyof typeof google.pubsub.v1.Subscription.State);
Subscription state.
topic
public topic: string;
Subscription topic.
topicMessageRetentionDuration
public topicMessageRetentionDuration?: (google.protobuf.IDuration|null);
Subscription topicMessageRetentionDuration.
Methods
create(properties)
public static create(properties?: google.pubsub.v1.ISubscription): google.pubsub.v1.Subscription;
Creates a new Subscription instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
ISubscription
Properties to set |
Returns | |
---|---|
Type | Description |
Subscription | Subscription instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.pubsub.v1.Subscription;
Decodes a Subscription message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
Subscription | Subscription |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.Subscription;
Decodes a Subscription message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Subscription | Subscription |
encode(message, writer)
public static encode(message: google.pubsub.v1.ISubscription, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Subscription message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ISubscription
Subscription message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.pubsub.v1.ISubscription, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Subscription message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ISubscription
Subscription message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.pubsub.v1.Subscription;
Creates a Subscription message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
Subscription | Subscription |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Subscription
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Subscription to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.pubsub.v1.Subscription, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Subscription message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Subscription
Subscription |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a Subscription message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|