Class google.cloud.scheduler.v1.Job (2.1.1)

Represents a Job.

Package

@google-cloud/scheduler!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.scheduler.v1.IJob);

Constructs a new Job.

Parameter
Name Description
properties IJob

Properties to set

Properties

appEngineHttpTarget

public appEngineHttpTarget?: (google.cloud.scheduler.v1.IAppEngineHttpTarget|null);

Job appEngineHttpTarget.

Property Value
Type Description
(google.cloud.scheduler.v1.IAppEngineHttpTarget|null)

attemptDeadline

public attemptDeadline?: (google.protobuf.IDuration|null);

Job attemptDeadline.

Property Value
Type Description
(google.protobuf.IDuration|null)

description

public description: string;

Job description.

Property Value
Type Description
string

httpTarget

public httpTarget?: (google.cloud.scheduler.v1.IHttpTarget|null);

Job httpTarget.

Property Value
Type Description
(google.cloud.scheduler.v1.IHttpTarget|null)

lastAttemptTime

public lastAttemptTime?: (google.protobuf.ITimestamp|null);

Job lastAttemptTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

name

public name: string;

Job name.

Property Value
Type Description
string

pubsubTarget

public pubsubTarget?: (google.cloud.scheduler.v1.IPubsubTarget|null);

Job pubsubTarget.

Property Value
Type Description
(google.cloud.scheduler.v1.IPubsubTarget|null)

retryConfig

public retryConfig?: (google.cloud.scheduler.v1.IRetryConfig|null);

Job retryConfig.

Property Value
Type Description
(google.cloud.scheduler.v1.IRetryConfig|null)

schedule

public schedule: string;

Job schedule.

Property Value
Type Description
string

scheduleTime

public scheduleTime?: (google.protobuf.ITimestamp|null);

Job scheduleTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

state

public state: (google.cloud.scheduler.v1.Job.State|keyof typeof google.cloud.scheduler.v1.Job.State);

Job state.

Property Value
Type Description
(google.cloud.scheduler.v1.Job.State|keyof typeof google.cloud.scheduler.v1.Job.State)

status

public status?: (google.rpc.IStatus|null);

Job status.

Property Value
Type Description
(google.rpc.IStatus|null)

target

public target?: ("pubsubTarget"|"appEngineHttpTarget"|"httpTarget");

Job target.

Property Value
Type Description
("pubsubTarget"|"appEngineHttpTarget"|"httpTarget")

timeZone

public timeZone: string;

Job timeZone.

Property Value
Type Description
string

userUpdateTime

public userUpdateTime?: (google.protobuf.ITimestamp|null);

Job userUpdateTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

Methods

create(properties)

public static create(properties?: google.cloud.scheduler.v1.IJob): google.cloud.scheduler.v1.Job;

Creates a new Job instance using the specified properties.

Parameter
Name Description
properties IJob

Properties to set
Returns
Type Description
Job

Job instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.scheduler.v1.Job;

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

Job

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.scheduler.v1.Job;

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

Job

encode(message, writer)

public static encode(message: google.cloud.scheduler.v1.IJob, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Job message. Does not implicitly messages.

Parameters
Name Description
message IJob

Job 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.scheduler.v1.IJob, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IJob

Job 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.scheduler.v1.Job;

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

Job

toJSON()

public toJSON(): { [k: string]: any };

Converts this Job to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.scheduler.v1.Job, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message Job

Job
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 Job message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not