Class protos.google.cloud.batch.v1.Job (2.3.0)
Represents a Job.
Package
@google-cloud/batchConstructors
(constructor)(properties)
constructor(properties?:google.cloud.batch.v1.IJob);Constructs a new Job.
| Parameter | |
|---|---|
| Name | Description |
properties | IJobProperties to set |
Properties
allocationPolicy
publicallocationPolicy?:(google.cloud.batch.v1.IAllocationPolicy|null);Job allocationPolicy.
createTime
publiccreateTime?:(google.protobuf.ITimestamp|null);Job createTime.
labels
publiclabels:{[k:string]:string};Job labels.
logsPolicy
publiclogsPolicy?:(google.cloud.batch.v1.ILogsPolicy|null);Job logsPolicy.
name
publicname:string;Job name.
notifications
publicnotifications:google.cloud.batch.v1.IJobNotification[];Job notifications.
priority
publicpriority:(number|Long|string);Job priority.
status
publicstatus?:(google.cloud.batch.v1.IJobStatus|null);Job status.
taskGroups
publictaskGroups:google.cloud.batch.v1.ITaskGroup[];Job taskGroups.
uid
publicuid:string;Job uid.
updateTime
publicupdateTime?:(google.protobuf.ITimestamp|null);Job updateTime.
Methods
create(properties)
publicstaticcreate(properties?:google.cloud.batch.v1.IJob):google.cloud.batch.v1.Job;Creates a new Job instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IJobProperties to set |
| Returns | |
|---|---|
| Type | Description |
Job | Job instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.cloud.batch.v1.Job;Decodes a Job message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Job | Job |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.cloud.batch.v1.Job;Decodes a Job message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Job | Job |
encode(message, writer)
publicstaticencode(message:google.cloud.batch.v1.IJob,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Job message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IJobJob message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.cloud.batch.v1.IJob,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Job message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IJobJob message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.cloud.batch.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 |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for Job
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this Job to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.cloud.batch.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 | JobJob |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(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) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.