Represents a Job.
Package
@google-cloud/scheduler!Constructors
(constructor)(properties)
constructor
(
properties
?:
google
.
cloud
.
scheduler
.
v1
.
IJob
);
Constructs a new Job.
| Name | Description |
|---|---|
| properties | IJob
Properties to set |
Properties
appEngineHttpTarget
public
appEngineHttpTarget
?:
(
google
.
cloud
.
scheduler
.
v1
.
IAppEngineHttpTarget
|
null
);
Job appEngineHttpTarget.
| Type | Description |
|---|---|
| ( google.cloud.scheduler.v1.IAppEngineHttpTarget |null) |
attemptDeadline
public
attemptDeadline
?:
(
google
.
protobuf
.
IDuration
|
null
);
Job attemptDeadline.
| Type | Description |
|---|---|
| ( google.protobuf.IDuration |null) |
description
public
description
:
string
;
Job description.
| Type | Description |
|---|---|
| string |
httpTarget
public
httpTarget
?:
(
google
.
cloud
.
scheduler
.
v1
.
IHttpTarget
|
null
);
Job httpTarget.
| Type | Description |
|---|---|
| ( google.cloud.scheduler.v1.IHttpTarget |null) |
lastAttemptTime
public
lastAttemptTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Job lastAttemptTime.
| Type | Description |
|---|---|
| ( google.protobuf.ITimestamp |null) |
name
public
name
:
string
;
Job name.
| Type | Description |
|---|---|
| string |
pubsubTarget
public
pubsubTarget
?:
(
google
.
cloud
.
scheduler
.
v1
.
IPubsubTarget
|
null
);
Job pubsubTarget.
| Type | Description |
|---|---|
| ( google.cloud.scheduler.v1.IPubsubTarget |null) |
retryConfig
public
retryConfig
?:
(
google
.
cloud
.
scheduler
.
v1
.
IRetryConfig
|
null
);
Job retryConfig.
| Type | Description |
|---|---|
| ( google.cloud.scheduler.v1.IRetryConfig |null) |
schedule
public
schedule
:
string
;
Job schedule.
| Type | Description |
|---|---|
| string |
scheduleTime
public
scheduleTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Job scheduleTime.
| 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.
| 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.
| Type | Description |
|---|---|
| ( google.rpc.IStatus |null) |
target
public
target
?:
(
"pubsubTarget"
|
"appEngineHttpTarget"
|
"httpTarget"
);
Job target.
| Type | Description |
|---|---|
| ("pubsubTarget"|"appEngineHttpTarget"|"httpTarget") |
timeZone
public
timeZone
:
string
;
Job timeZone.
| Type | Description |
|---|---|
| string |
userUpdateTime
public
userUpdateTime
?:
(
google
.
protobuf
.
ITimestamp
|
null
);
Job userUpdateTime.
| 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.
| Name | Description |
|---|---|
| properties | IJob
Properties to set |
| 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.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| length | number
Message length if known beforehand |
| 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.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| 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.
| Name | Description |
| message | IJob
Job message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| 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.
| Name | Description |
| message | IJob
Job message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| 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.
| Name | Description |
| object | { [k: string]: any }
Plain object |
| Type | Description |
|---|---|
| Job | Job |
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this Job to JSON.
| 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.
| Name | Description |
| message | Job
Job |
| options | $protobuf. IConversionOptions
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public
static
verify
(
message
:
{
[
k
:
string
]
:
any
})
:
(
string
|
null
);
Verifies a Job message.
| Name | Description |
| message | { [k: string]: any }
Plain object to verify |
| Type | Description |
| (string|null) | |
