Job

google.cloud.scheduler.v1beta1. Job

Represents a Job.

Constructor

new Job(propertiesopt)

Constructs a new Job.

Parameters:
Name Type Attributes Description
properties google.cloud.scheduler.v1beta1.IJob <optional>

Properties to set

Implements:
  • IJob

Members

appEngineHttpTarget

Job appEngineHttpTarget.

attemptDeadline

Job attemptDeadline.

description

Job description.

httpTarget

Job httpTarget.

lastAttemptTime

Job lastAttemptTime.

legacyAppEngineCron

Job legacyAppEngineCron.

name

Job name.

pubsubTarget

Job pubsubTarget.

retryConfig

Job retryConfig.

schedule

Job schedule.

scheduleTime

Job scheduleTime.

state

Job state.

status

Job status.

target

Job target.

timeZone

Job timeZone.

userUpdateTime

Job userUpdateTime.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

ENABLED number

ENABLED value

PAUSED number

PAUSED value

DISABLED number

DISABLED value

UPDATE_FAILED number

UPDATE_FAILED value

Methods

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

Converts this Job to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.scheduler.v1beta1.Job}

Creates a new Job instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.scheduler.v1beta1.IJob <optional>

Properties to set

Returns:
Type Description
google.cloud.scheduler.v1beta1.Job

Job instance

(static) decode(reader, lengthopt) → {google.cloud.scheduler.v1beta1.Job}

Decodes a Job 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.scheduler.v1beta1.Job

Job

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.scheduler.v1beta1.Job}

Decodes a Job 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.scheduler.v1beta1.Job

Job

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 Job message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.scheduler.v1beta1.IJob

Job 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 Job message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.scheduler.v1beta1.IJob

Job 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.scheduler.v1beta1.Job}

Creates a Job 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.scheduler.v1beta1.Job

Job

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Job

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 Job message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.scheduler.v1beta1.Job

Job

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a Job 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