Class protos.google.pubsub.v1.AcknowledgeRequest

Represents an AcknowledgeRequest.

Package

@google-cloud/pubsub

Constructors

(constructor)(properties)

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

Constructs a new AcknowledgeRequest.

Parameter
NameDescription
properties IAcknowledgeRequest

Properties to set

Properties

ackIds

public ackIds: string[];

AcknowledgeRequest ackIds.

Property Value
TypeDescription
string[]

subscription

public subscription: string;

AcknowledgeRequest subscription.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.pubsub.v1.IAcknowledgeRequest): google.pubsub.v1.AcknowledgeRequest;

Creates a new AcknowledgeRequest instance using the specified properties.

Parameter
NameDescription
properties IAcknowledgeRequest

Properties to set

Returns
TypeDescription
google.pubsub.v1.AcknowledgeRequest

AcknowledgeRequest instance

decode(reader, length)

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

Decodes an AcknowledgeRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.pubsub.v1.AcknowledgeRequest

AcknowledgeRequest

decodeDelimited(reader)

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

Decodes an AcknowledgeRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.pubsub.v1.AcknowledgeRequest

AcknowledgeRequest

encode(message, writer)

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

Encodes the specified AcknowledgeRequest message. Does not implicitly messages.

Parameters
NameDescription
message IAcknowledgeRequest

AcknowledgeRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IAcknowledgeRequest

AcknowledgeRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.pubsub.v1.AcknowledgeRequest;

Creates an AcknowledgeRequest message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.pubsub.v1.AcknowledgeRequest

AcknowledgeRequest

toJSON()

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

Converts this AcknowledgeRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.pubsub.v1.AcknowledgeRequest

AcknowledgeRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an AcknowledgeRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not