Class protos.google.pubsub.v1.DeadLetterPolicy (2.16.6)

Represents a DeadLetterPolicy.

Package

@google-cloud/pubsub!

Constructors

(constructor)(properties)

constructor(properties?: google.pubsub.v1.IDeadLetterPolicy);

Constructs a new DeadLetterPolicy.

Parameter

Name	Description
properties	`IDeadLetterPolicy` Properties to set

Properties

deadLetterTopic

public deadLetterTopic: string;

DeadLetterPolicy deadLetterTopic.

Property Value

Type	Description
string

maxDeliveryAttempts

public maxDeliveryAttempts: number;

DeadLetterPolicy maxDeliveryAttempts.

Property Value

Type	Description
number

Methods

create(properties)

public static create(properties?: google.pubsub.v1.IDeadLetterPolicy): google.pubsub.v1.DeadLetterPolicy;

Creates a new DeadLetterPolicy instance using the specified properties.

Parameter

Name	Description
properties	`IDeadLetterPolicy` Properties to set

Returns

Type	Description
google.pubsub.v1.DeadLetterPolicy	DeadLetterPolicy instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.pubsub.v1.DeadLetterPolicy;

Decodes a DeadLetterPolicy message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.pubsub.v1.DeadLetterPolicy	DeadLetterPolicy

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.DeadLetterPolicy;

Decodes a DeadLetterPolicy message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.pubsub.v1.DeadLetterPolicy	DeadLetterPolicy

encode(message, writer)

public static encode(message: google.pubsub.v1.IDeadLetterPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DeadLetterPolicy message. Does not implicitly messages.

Parameters

Name	Description
message	`IDeadLetterPolicy` DeadLetterPolicy 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.IDeadLetterPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DeadLetterPolicy message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IDeadLetterPolicy` DeadLetterPolicy 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.DeadLetterPolicy;

Creates a DeadLetterPolicy 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
google.pubsub.v1.DeadLetterPolicy	DeadLetterPolicy

toJSON()

public toJSON(): { [k: string]: any };

Converts this DeadLetterPolicy to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.pubsub.v1.DeadLetterPolicy, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a DeadLetterPolicy message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.pubsub.v1.DeadLetterPolicy` DeadLetterPolicy
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 DeadLetterPolicy message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not