Queue

google.cloud.tasks.v2beta3. Queue

Represents a Queue.

Constructor

new Queue(propertiesopt)

Constructs a new Queue.

Parameters:
Name Type Attributes Description
properties google.cloud.tasks.v2beta3.IQueue <optional>

Properties to set

Implements:
  • IQueue

Members

appEngineHttpQueue

Queue appEngineHttpQueue.

name

Queue name.

purgeTime

Queue purgeTime.

queueType

Queue queueType.

rateLimits

Queue rateLimits.

retryConfig

Queue retryConfig.

stackdriverLoggingConfig

Queue stackdriverLoggingConfig.

state

Queue state.

stats

Queue stats.

taskTtl

Queue taskTtl.

tombstoneTtl

Queue tombstoneTtl.

type

Queue type.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

RUNNING number

RUNNING value

PAUSED number

PAUSED value

DISABLED number

DISABLED value

Type

Type enum.

Properties:
Name Type Description
TYPE_UNSPECIFIED number

TYPE_UNSPECIFIED value

PULL number

PULL value

PUSH number

PUSH value

Methods

toJSON() → {Object.<string, *>}

Converts this Queue to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.tasks.v2beta3.Queue}

Creates a new Queue instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.tasks.v2beta3.IQueue <optional>

Properties to set

Returns:
Type Description
google.cloud.tasks.v2beta3.Queue

Queue instance

(static) decode(reader, lengthopt) → {google.cloud.tasks.v2beta3.Queue}

Decodes a Queue message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.tasks.v2beta3.Queue

Queue

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.tasks.v2beta3.Queue}

Decodes a Queue message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.tasks.v2beta3.Queue

Queue

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Queue message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.tasks.v2beta3.IQueue

Queue message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.tasks.v2beta3.IQueue

Queue message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.tasks.v2beta3.Queue}

Creates a Queue message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.tasks.v2beta3.Queue

Queue

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Queue

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.tasks.v2beta3.Queue

Queue

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Queue message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not