Represents a Job.
Package
@google-cloud/schedulerConstructors
(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.
attemptDeadline
public attemptDeadline?: (google.protobuf.IDuration|null);Job attemptDeadline.
description
public description: string;Job description.
httpTarget
public httpTarget?: (google.cloud.scheduler.v1.IHttpTarget|null);Job httpTarget.
lastAttemptTime
public lastAttemptTime?: (google.protobuf.ITimestamp|null);Job lastAttemptTime.
name
public name: string;Job name.
pubsubTarget
public pubsubTarget?: (google.cloud.scheduler.v1.IPubsubTarget|null);Job pubsubTarget.
retryConfig
public retryConfig?: (google.cloud.scheduler.v1.IRetryConfig|null);Job retryConfig.
schedule
public schedule: string;Job schedule.
scheduleTime
public scheduleTime?: (google.protobuf.ITimestamp|null);Job scheduleTime.
state
public state: (google.cloud.scheduler.v1.Job.State|keyof typeof google.cloud.scheduler.v1.Job.State);Job state.
status
public status?: (google.rpc.IStatus|null);Job status.
target
public target?: ("pubsubTarget"|"appEngineHttpTarget"|"httpTarget");Job target.
timeZone
public timeZone: string;Job timeZone.
userUpdateTime
public userUpdateTime?: (google.protobuf.ITimestamp|null);Job userUpdateTime.
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 |
google.cloud.scheduler.v1.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 |
google.cloud.scheduler.v1.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 |
google.cloud.scheduler.v1.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 |
google.cloud.scheduler.v1.Job | Job |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Job
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
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 |
google.cloud.scheduler.v1.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) |
|