Class protos.google.cloud.batch.v1alpha.TaskSpec (1.3.0)

Represents a TaskSpec.

Package

@google-cloud/batch

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.batch.v1alpha.ITaskSpec);

Constructs a new TaskSpec.

Parameter
NameDescription
properties ITaskSpec

Properties to set

Properties

computeResource

public computeResource?: (google.cloud.batch.v1alpha.IComputeResource|null);

TaskSpec computeResource.

environment

public environment?: (google.cloud.batch.v1alpha.IEnvironment|null);

TaskSpec environment.

environments

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

TaskSpec environments.

lifecyclePolicies

public lifecyclePolicies: google.cloud.batch.v1alpha.ILifecyclePolicy[];

TaskSpec lifecyclePolicies.

maxRetryCount

public maxRetryCount: number;

TaskSpec maxRetryCount.

maxRunDuration

public maxRunDuration?: (google.protobuf.IDuration|null);

TaskSpec maxRunDuration.

runnables

public runnables: google.cloud.batch.v1alpha.IRunnable[];

TaskSpec runnables.

volumes

public volumes: google.cloud.batch.v1alpha.IVolume[];

TaskSpec volumes.

Methods

create(properties)

public static create(properties?: google.cloud.batch.v1alpha.ITaskSpec): google.cloud.batch.v1alpha.TaskSpec;

Creates a new TaskSpec instance using the specified properties.

Parameter
NameDescription
properties ITaskSpec

Properties to set

Returns
TypeDescription
TaskSpec

TaskSpec instance

decode(reader, length)

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

Decodes a TaskSpec 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
TaskSpec

TaskSpec

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
TaskSpec

TaskSpec

encode(message, writer)

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

Encodes the specified TaskSpec message. Does not implicitly messages.

Parameters
NameDescription
message ITaskSpec

TaskSpec 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.v1alpha.ITaskSpec, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ITaskSpec

TaskSpec 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.v1alpha.TaskSpec;

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

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

Plain object

Returns
TypeDescription
TaskSpec

TaskSpec

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TaskSpec

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 TaskSpec to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message TaskSpec

TaskSpec

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 TaskSpec 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