Represents a Runnable.
Package
@google-cloud/batchConstructors
(constructor)(properties)
constructor(properties?: google.cloud.batch.v1.IRunnable);
Constructs a new Runnable.
Name | Description |
properties |
IRunnable
Properties to set |
Properties
alwaysRun
public alwaysRun: boolean;
Runnable alwaysRun.
background
public background: boolean;
Runnable background.
barrier
public barrier?: (google.cloud.batch.v1.Runnable.IBarrier|null);
Runnable barrier.
container
public container?: (google.cloud.batch.v1.Runnable.IContainer|null);
Runnable container.
environment
public environment?: (google.cloud.batch.v1.IEnvironment|null);
Runnable environment.
executable
public executable?: ("container"|"script"|"barrier");
Runnable executable.
ignoreExitStatus
public ignoreExitStatus: boolean;
Runnable ignoreExitStatus.
script
public script?: (google.cloud.batch.v1.Runnable.IScript|null);
Runnable script.
timeout
public timeout?: (google.protobuf.IDuration|null);
Runnable timeout.
Methods
create(properties)
public static create(properties?: google.cloud.batch.v1.IRunnable): google.cloud.batch.v1.Runnable;
Creates a new Runnable instance using the specified properties.
Name | Description |
properties |
IRunnable
Properties to set |
Type | Description |
google.cloud.batch.v1.Runnable | Runnable instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.batch.v1.Runnable;
Decodes a Runnable 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 |
google.cloud.batch.v1.Runnable | Runnable |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.batch.v1.Runnable;
Decodes a Runnable message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.cloud.batch.v1.Runnable | Runnable |
encode(message, writer)
public static encode(message: google.cloud.batch.v1.IRunnable, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Runnable message. Does not implicitly messages.
Name | Description |
message |
IRunnable
Runnable 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.batch.v1.IRunnable, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Runnable message, length delimited. Does not implicitly messages.
Name | Description |
message |
IRunnable
Runnable 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.batch.v1.Runnable;
Creates a Runnable message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.cloud.batch.v1.Runnable | Runnable |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Runnable
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Runnable to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.batch.v1.Runnable, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Runnable message. Also converts values to other types if specified.
Name | Description |
message |
google.cloud.batch.v1.Runnable
Runnable |
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 Runnable message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|