Represents a Queue.
Package
@google-cloud/tasks!Constructors
(constructor)(properties)
constructor(properties?: google.cloud.tasks.v2beta2.IQueue);
Constructs a new Queue.
Name | Description |
properties |
IQueue
Properties to set |
Properties
appEngineHttpTarget
public appEngineHttpTarget?: (google.cloud.tasks.v2beta2.IAppEngineHttpTarget|null);
Queue appEngineHttpTarget.
Type | Description |
(google.cloud.tasks.v2beta2.IAppEngineHttpTarget|null) |
name
public name: string;
Queue name.
Type | Description |
string |
pullTarget
public pullTarget?: (google.cloud.tasks.v2beta2.IPullTarget|null);
Queue pullTarget.
Type | Description |
(google.cloud.tasks.v2beta2.IPullTarget|null) |
purgeTime
public purgeTime?: (google.protobuf.ITimestamp|null);
Queue purgeTime.
Type | Description |
(google.protobuf.ITimestamp|null) |
rateLimits
public rateLimits?: (google.cloud.tasks.v2beta2.IRateLimits|null);
Queue rateLimits.
Type | Description |
(google.cloud.tasks.v2beta2.IRateLimits|null) |
retryConfig
public retryConfig?: (google.cloud.tasks.v2beta2.IRetryConfig|null);
Queue retryConfig.
Type | Description |
(google.cloud.tasks.v2beta2.IRetryConfig|null) |
state
public state: (google.cloud.tasks.v2beta2.Queue.State|keyof typeof google.cloud.tasks.v2beta2.Queue.State);
Queue state.
Type | Description |
(google.cloud.tasks.v2beta2.Queue.State|keyof typeof google.cloud.tasks.v2beta2.Queue.State) |
stats
public stats?: (google.cloud.tasks.v2beta2.IQueueStats|null);
Queue stats.
Type | Description |
(google.cloud.tasks.v2beta2.IQueueStats|null) |
targetType
public targetType?: ("appEngineHttpTarget"|"pullTarget");
Queue targetType.
Type | Description |
("appEngineHttpTarget"|"pullTarget") |
taskTtl
public taskTtl?: (google.protobuf.IDuration|null);
Queue taskTtl.
Type | Description |
(google.protobuf.IDuration|null) |
tombstoneTtl
public tombstoneTtl?: (google.protobuf.IDuration|null);
Queue tombstoneTtl.
Type | Description |
(google.protobuf.IDuration|null) |
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.
Name | Description |
properties |
IQueue
Properties to set |
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.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
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.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
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.
Name | Description |
message |
IQueue
Queue 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.cloud.tasks.v2beta2.IQueue, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Queue message, length delimited. Does not implicitly messages.
Name | Description |
message |
IQueue
Queue 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.cloud.tasks.v2beta2.Queue;
Creates a Queue message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.cloud.tasks.v2beta2.Queue | Queue |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Queue to JSON.
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.
Name | Description |
message |
google.cloud.tasks.v2beta2.Queue
Queue |
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 Queue message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|