Class protos.google.cloud.batch.v1.TaskGroup (1.1.0)

Represents a TaskGroup.

Package

@google-cloud/batch

Constructors

(constructor)(properties)

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

Constructs a new TaskGroup.

Parameter
NameDescription
properties ITaskGroup

Properties to set

Properties

name

public name: string;

TaskGroup name.

parallelism

public parallelism: (number|Long|string);

TaskGroup parallelism.

permissiveSsh

public permissiveSsh: boolean;

TaskGroup permissiveSsh.

requireHostsFile

public requireHostsFile: boolean;

TaskGroup requireHostsFile.

schedulingPolicy

public schedulingPolicy: (google.cloud.batch.v1.TaskGroup.SchedulingPolicy|keyof typeof google.cloud.batch.v1.TaskGroup.SchedulingPolicy);

TaskGroup schedulingPolicy.

taskCount

public taskCount: (number|Long|string);

TaskGroup taskCount.

taskCountPerNode

public taskCountPerNode: (number|Long|string);

TaskGroup taskCountPerNode.

taskEnvironments

public taskEnvironments: google.cloud.batch.v1.IEnvironment[];

TaskGroup taskEnvironments.

taskSpec

public taskSpec?: (google.cloud.batch.v1.ITaskSpec|null);

TaskGroup taskSpec.

Methods

create(properties)

public static create(properties?: google.cloud.batch.v1.ITaskGroup): google.cloud.batch.v1.TaskGroup;

Creates a new TaskGroup instance using the specified properties.

Parameter
NameDescription
properties ITaskGroup

Properties to set

Returns
TypeDescription
TaskGroup

TaskGroup instance

decode(reader, length)

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

Decodes a TaskGroup message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
TaskGroup

TaskGroup

decodeDelimited(reader)

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

Decodes a TaskGroup message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
TaskGroup

TaskGroup

encode(message, writer)

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

Encodes the specified TaskGroup message. Does not implicitly messages.

Parameters
NameDescription
message ITaskGroup

TaskGroup message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.batch.v1.ITaskGroup, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ITaskGroup

TaskGroup message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.batch.v1.TaskGroup;

Creates a TaskGroup message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
TaskGroup

TaskGroup

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for TaskGroup

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this TaskGroup to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message TaskGroup

TaskGroup

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a TaskGroup message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not