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

Represents a PullResponse.

Package

@google-cloud/pubsub!

Constructors

(constructor)(properties)

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

Constructs a new PullResponse.

Parameter

Name	Description
properties	`IPullResponse` Properties to set

Properties

receivedMessages

public receivedMessages: google.pubsub.v1.IReceivedMessage[];

PullResponse receivedMessages.

Property Value

Type	Description
google.pubsub.v1.IReceivedMessage[]

Methods

create(properties)

public static create(properties?: google.pubsub.v1.IPullResponse): google.pubsub.v1.PullResponse;

Creates a new PullResponse instance using the specified properties.

Parameter

Name	Description
properties	`IPullResponse` Properties to set

Returns

Type	Description
google.pubsub.v1.PullResponse	PullResponse instance

decode(reader, length)

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

Decodes a PullResponse 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.PullResponse	PullResponse

decodeDelimited(reader)

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

Decodes a PullResponse 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.PullResponse	PullResponse

encode(message, writer)

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

Encodes the specified PullResponse message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IPullResponse` PullResponse 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.PullResponse;

Creates a PullResponse 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.PullResponse	PullResponse

toJSON()

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

Converts this PullResponse to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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