Class protos.google.pubsub.v1.StreamingPullResponse (3.1.0)

Represents a StreamingPullResponse.

Package

@google-cloud/pubsub

Constructors

(constructor)(properties)

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

Constructs a new StreamingPullResponse.

Parameter
NameDescription
properties IStreamingPullResponse

Properties to set

Properties

acknowledgeConfirmation

public acknowledgeConfirmation?: (google.pubsub.v1.StreamingPullResponse.IAcknowledgeConfirmation|null);

StreamingPullResponse acknowledgeConfirmation.

modifyAckDeadlineConfirmation

public modifyAckDeadlineConfirmation?: (google.pubsub.v1.StreamingPullResponse.IModifyAckDeadlineConfirmation|null);

StreamingPullResponse modifyAckDeadlineConfirmation.

receivedMessages

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

StreamingPullResponse receivedMessages.

subscriptionProperties

public subscriptionProperties?: (google.pubsub.v1.StreamingPullResponse.ISubscriptionProperties|null);

StreamingPullResponse subscriptionProperties.

Methods

create(properties)

public static create(properties?: google.pubsub.v1.IStreamingPullResponse): google.pubsub.v1.StreamingPullResponse;

Creates a new StreamingPullResponse instance using the specified properties.

Parameter
NameDescription
properties IStreamingPullResponse

Properties to set

Returns
TypeDescription
google.pubsub.v1.StreamingPullResponse

StreamingPullResponse instance

decode(reader, length)

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

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

StreamingPullResponse

decodeDelimited(reader)

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

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

StreamingPullResponse

encode(message, writer)

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

Encodes the specified StreamingPullResponse message. Does not implicitly messages.

Parameters
NameDescription
message IStreamingPullResponse

StreamingPullResponse 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.IStreamingPullResponse, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IStreamingPullResponse

StreamingPullResponse 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.StreamingPullResponse;

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

StreamingPullResponse

toJSON()

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

Converts this StreamingPullResponse to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.pubsub.v1.StreamingPullResponse

StreamingPullResponse

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a StreamingPullResponse 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