Class protos.google.cloud.batch.v1.Job (0.3.2)

Represents a Job.

Package

@google-cloud/batch

Constructors

(constructor)(properties)

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

Constructs a new Job.

Parameter
Name Description
properties IJob

Properties to set

Properties

allocationPolicy

public allocationPolicy?: (google.cloud.batch.v1.IAllocationPolicy|null);

Job allocationPolicy.

createTime

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

Job createTime.

labels

public labels: { [k: string]: string };

Job labels.

logsPolicy

public logsPolicy?: (google.cloud.batch.v1.ILogsPolicy|null);

Job logsPolicy.

name

public name: string;

Job name.

notifications

public notifications: google.cloud.batch.v1.IJobNotification[];

Job notifications.

priority

public priority: (number|Long|string);

Job priority.

status

public status?: (google.cloud.batch.v1.IJobStatus|null);

Job status.

taskGroups

public taskGroups: google.cloud.batch.v1.ITaskGroup[];

Job taskGroups.

uid

public uid: string;

Job uid.

updateTime

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

Job updateTime.

Methods

create(properties)

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

Creates a new Job instance using the specified properties.

Parameter
Name Description
properties IJob

Properties to set
Returns
Type Description
google.cloud.batch.v1.Job

Job instance

decode(reader, length)

public static decode(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 ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.batch.v1.Job

Job

decodeDelimited(reader)

public static decodeDelimited(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 ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.batch.v1.Job

Job

encode(message, writer)

public static encode(message: google.cloud.batch.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.batch.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.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
google.cloud.batch.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.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 google.cloud.batch.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)

null if valid, otherwise the reason why it is not