Represents a BatchingSettingsProto.
Implements
Package
@google-cloud/retailConstructors
(constructor)(properties)
constructor(properties?: google.api.IBatchingSettingsProto);Constructs a new BatchingSettingsProto.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBatchingSettingsProto
Properties to set |
Properties
delayThreshold
public delayThreshold?: (google.protobuf.IDuration|null);BatchingSettingsProto delayThreshold.
elementCountLimit
public elementCountLimit: number;BatchingSettingsProto elementCountLimit.
elementCountThreshold
public elementCountThreshold: number;BatchingSettingsProto elementCountThreshold.
flowControlByteLimit
public flowControlByteLimit: number;BatchingSettingsProto flowControlByteLimit.
flowControlElementLimit
public flowControlElementLimit: number;BatchingSettingsProto flowControlElementLimit.
flowControlLimitExceededBehavior
public flowControlLimitExceededBehavior: (google.api.FlowControlLimitExceededBehaviorProto|keyof typeof google.api.FlowControlLimitExceededBehaviorProto);BatchingSettingsProto flowControlLimitExceededBehavior.
requestByteLimit
public requestByteLimit: number;BatchingSettingsProto requestByteLimit.
requestByteThreshold
public requestByteThreshold: (number|Long|string);BatchingSettingsProto requestByteThreshold.
Methods
create(properties)
public static create(properties?: google.api.IBatchingSettingsProto): google.api.BatchingSettingsProto;Creates a new BatchingSettingsProto instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBatchingSettingsProto
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BatchingSettingsProto |
BatchingSettingsProto instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.BatchingSettingsProto;Decodes a BatchingSettingsProto message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
BatchingSettingsProto |
BatchingSettingsProto |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.BatchingSettingsProto;Decodes a BatchingSettingsProto message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BatchingSettingsProto |
BatchingSettingsProto |
encode(message, writer)
public static encode(message: google.api.IBatchingSettingsProto, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BatchingSettingsProto message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBatchingSettingsProto
BatchingSettingsProto 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.api.IBatchingSettingsProto, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BatchingSettingsProto message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBatchingSettingsProto
BatchingSettingsProto 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.api.BatchingSettingsProto;Creates a BatchingSettingsProto 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 |
BatchingSettingsProto |
BatchingSettingsProto |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BatchingSettingsProto
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this BatchingSettingsProto to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.api.BatchingSettingsProto, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BatchingSettingsProto message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BatchingSettingsProto
BatchingSettingsProto |
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 BatchingSettingsProto message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|