Job

google.cloud.scheduler.v1. Job

Represents a Job.

Constructor

new Job(propertiesopt)

Constructs a new Job.

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

Properties to set

Implements:
  • IJob

Members

(static) State :number

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

appEngineHttpTarget :google.cloud.scheduler.v1.IAppEngineHttpTarget|null|undefined

Job appEngineHttpTarget.

attemptDeadline :google.protobuf.IDuration|null|undefined

Job attemptDeadline.

description :string

Job description.

httpTarget :google.cloud.scheduler.v1.IHttpTarget|null|undefined

Job httpTarget.

lastAttemptTime :google.protobuf.ITimestamp|null|undefined

Job lastAttemptTime.

name :string

Job name.

pubsubTarget :google.cloud.scheduler.v1.IPubsubTarget|null|undefined

Job pubsubTarget.

retryConfig :google.cloud.scheduler.v1.IRetryConfig|null|undefined

Job retryConfig.

schedule :string

Job schedule.

scheduleTime :google.protobuf.ITimestamp|null|undefined

Job scheduleTime.

state :google.cloud.scheduler.v1.Job.State

Job state.

status :google.rpc.IStatus|null|undefined

Job status.

target :"pubsubTarget"|"appEngineHttpTarget"|"httpTarget"|undefined

Job target.

timeZone :string

Job timeZone.

userUpdateTime :google.protobuf.ITimestamp|null|undefined

Job userUpdateTime.

Methods

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

Creates a new Job instance using the specified properties.

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

Properties to set

(static) decode(reader, lengthopt) → {google.cloud.scheduler.v1.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

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.v1.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

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.v1.IJob

Job message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(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.v1.IJob

Job message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.cloud.scheduler.v1.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

(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.v1.Job

Job

options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies a Job message.

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

Plain object to verify

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

Converts this Job to JSON.