Class protos.google.cloud.tasks.v2beta3.Queue (2.3.6)

Represents a Queue.

Package

@google-cloud/tasks!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.tasks.v2beta3.IQueue);

Constructs a new Queue.

Parameter
Name Description
properties IQueue

Properties to set

Properties

appEngineHttpQueue

public appEngineHttpQueue?: (google.cloud.tasks.v2beta3.IAppEngineHttpQueue|null);

Queue appEngineHttpQueue.

Property Value
Type Description
(google.cloud.tasks.v2beta3.IAppEngineHttpQueue|null)

name

public name: string;

Queue name.

Property Value
Type Description
string

purgeTime

public purgeTime?: (google.protobuf.ITimestamp|null);

Queue purgeTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

queueType

public queueType?: "appEngineHttpQueue";

Queue queueType.

Property Value
Type Description
"appEngineHttpQueue"

rateLimits

public rateLimits?: (google.cloud.tasks.v2beta3.IRateLimits|null);

Queue rateLimits.

Property Value
Type Description
(google.cloud.tasks.v2beta3.IRateLimits|null)

retryConfig

public retryConfig?: (google.cloud.tasks.v2beta3.IRetryConfig|null);

Queue retryConfig.

Property Value
Type Description
(google.cloud.tasks.v2beta3.IRetryConfig|null)

stackdriverLoggingConfig

public stackdriverLoggingConfig?: (google.cloud.tasks.v2beta3.IStackdriverLoggingConfig|null);

Queue stackdriverLoggingConfig.

Property Value
Type Description
(google.cloud.tasks.v2beta3.IStackdriverLoggingConfig|null)

state

public state: (google.cloud.tasks.v2beta3.Queue.State|keyof typeof google.cloud.tasks.v2beta3.Queue.State);

Queue state.

Property Value
Type Description
(google.cloud.tasks.v2beta3.Queue.State|keyof typeof google.cloud.tasks.v2beta3.Queue.State)

stats

public stats?: (google.cloud.tasks.v2beta3.IQueueStats|null);

Queue stats.

Property Value
Type Description
(google.cloud.tasks.v2beta3.IQueueStats|null)

taskTtl

public taskTtl?: (google.protobuf.IDuration|null);

Queue taskTtl.

Property Value
Type Description
(google.protobuf.IDuration|null)

tombstoneTtl

public tombstoneTtl?: (google.protobuf.IDuration|null);

Queue tombstoneTtl.

Property Value
Type Description
(google.protobuf.IDuration|null)

type

public type: (google.cloud.tasks.v2beta3.Queue.Type|keyof typeof google.cloud.tasks.v2beta3.Queue.Type);

Queue type.

Property Value
Type Description
(google.cloud.tasks.v2beta3.Queue.Type|keyof typeof google.cloud.tasks.v2beta3.Queue.Type)

Methods

create(properties)

public static create(properties?: google.cloud.tasks.v2beta3.IQueue): google.cloud.tasks.v2beta3.Queue;

Creates a new Queue instance using the specified properties.

Parameter
Name Description
properties IQueue

Properties to set
Returns
Type Description
google.cloud.tasks.v2beta3.Queue

Queue instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tasks.v2beta3.Queue;

Decodes a Queue 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.cloud.tasks.v2beta3.Queue

Queue

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tasks.v2beta3.Queue;

Decodes a Queue 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.cloud.tasks.v2beta3.Queue

Queue

encode(message, writer)

public static encode(message: google.cloud.tasks.v2beta3.IQueue, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Queue message. Does not implicitly messages.

Parameters
Name Description
message IQueue

Queue 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.cloud.tasks.v2beta3.IQueue, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IQueue

Queue 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.cloud.tasks.v2beta3.Queue;

Creates a Queue 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.cloud.tasks.v2beta3.Queue

Queue

toJSON()

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

Converts this Queue to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.tasks.v2beta3.Queue, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message google.cloud.tasks.v2beta3.Queue

Queue
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 Queue 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