Represents a Queue.
Package
@google-cloud/tasksConstructors
(constructor)(properties)
constructor(properties?: google.cloud.tasks.v2beta2.IQueue);Constructs a new Queue.
| Parameter | |
|---|---|
| Name | Description |
properties |
IQueue
Properties to set |
Properties
appEngineHttpTarget
public appEngineHttpTarget?: (google.cloud.tasks.v2beta2.IAppEngineHttpTarget|null);Queue appEngineHttpTarget.
name
public name: string;Queue name.
pullTarget
public pullTarget?: (google.cloud.tasks.v2beta2.IPullTarget|null);Queue pullTarget.
purgeTime
public purgeTime?: (google.protobuf.ITimestamp|null);Queue purgeTime.
rateLimits
public rateLimits?: (google.cloud.tasks.v2beta2.IRateLimits|null);Queue rateLimits.
retryConfig
public retryConfig?: (google.cloud.tasks.v2beta2.IRetryConfig|null);Queue retryConfig.
state
public state: (google.cloud.tasks.v2beta2.Queue.State|keyof typeof google.cloud.tasks.v2beta2.Queue.State);Queue state.
stats
public stats?: (google.cloud.tasks.v2beta2.IQueueStats|null);Queue stats.
targetType
public targetType?: ("appEngineHttpTarget"|"pullTarget");Queue targetType.
taskTtl
public taskTtl?: (google.protobuf.IDuration|null);Queue taskTtl.
tombstoneTtl
public tombstoneTtl?: (google.protobuf.IDuration|null);Queue tombstoneTtl.
Methods
create(properties)
public static create(properties?: google.cloud.tasks.v2beta2.IQueue): google.cloud.tasks.v2beta2.Queue;Creates a new Queue instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IQueue
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.tasks.v2beta2.Queue | Queue instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tasks.v2beta2.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.v2beta2.Queue | Queue |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tasks.v2beta2.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.v2beta2.Queue | Queue |
encode(message, writer)
public static encode(message: google.cloud.tasks.v2beta2.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.v2beta2.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.v2beta2.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.v2beta2.Queue | Queue |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Queue
| 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 Queue to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.tasks.v2beta2.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.v2beta2.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) |
|