Represents a StreamingPullRequest.
Package
@google-cloud/pubsub!Constructors
(constructor)(properties)
constructor(properties?: google.pubsub.v1.IStreamingPullRequest);
Constructs a new StreamingPullRequest.
Name | Description |
properties |
IStreamingPullRequest
Properties to set |
Properties
ackIds
public ackIds: string[];
StreamingPullRequest ackIds.
Type | Description |
string[] |
clientId
public clientId: string;
StreamingPullRequest clientId.
Type | Description |
string |
maxOutstandingBytes
public maxOutstandingBytes: (number|Long|string);
StreamingPullRequest maxOutstandingBytes.
Type | Description |
(number|Long|string) |
maxOutstandingMessages
public maxOutstandingMessages: (number|Long|string);
StreamingPullRequest maxOutstandingMessages.
Type | Description |
(number|Long|string) |
modifyDeadlineAckIds
public modifyDeadlineAckIds: string[];
StreamingPullRequest modifyDeadlineAckIds.
Type | Description |
string[] |
modifyDeadlineSeconds
public modifyDeadlineSeconds: number[];
StreamingPullRequest modifyDeadlineSeconds.
Type | Description |
number[] |
streamAckDeadlineSeconds
public streamAckDeadlineSeconds: number;
StreamingPullRequest streamAckDeadlineSeconds.
Type | Description |
number |
subscription
public subscription: string;
StreamingPullRequest subscription.
Type | Description |
string |
Methods
create(properties)
public static create(properties?: google.pubsub.v1.IStreamingPullRequest): google.pubsub.v1.StreamingPullRequest;
Creates a new StreamingPullRequest instance using the specified properties.
Name | Description |
properties |
IStreamingPullRequest
Properties to set |
Type | Description |
google.pubsub.v1.StreamingPullRequest | StreamingPullRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.pubsub.v1.StreamingPullRequest;
Decodes a StreamingPullRequest message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
google.pubsub.v1.StreamingPullRequest | StreamingPullRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.StreamingPullRequest;
Decodes a StreamingPullRequest message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.pubsub.v1.StreamingPullRequest | StreamingPullRequest |
encode(message, writer)
public static encode(message: google.pubsub.v1.IStreamingPullRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified StreamingPullRequest message. Does not implicitly messages.
Name | Description |
message |
IStreamingPullRequest
StreamingPullRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.pubsub.v1.IStreamingPullRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified StreamingPullRequest message, length delimited. Does not implicitly messages.
Name | Description |
message |
IStreamingPullRequest
StreamingPullRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.pubsub.v1.StreamingPullRequest;
Creates a StreamingPullRequest message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.pubsub.v1.StreamingPullRequest | StreamingPullRequest |
toJSON()
public toJSON(): { [k: string]: any };
Converts this StreamingPullRequest to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.pubsub.v1.StreamingPullRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a StreamingPullRequest message. Also converts values to other types if specified.
Name | Description |
message |
google.pubsub.v1.StreamingPullRequest
StreamingPullRequest |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a StreamingPullRequest message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|