Class protos.google.cloud.batch.v1.Volume (1.8.0)

Represents a Volume.

Package

@google-cloud/batch

Constructors

(constructor)(properties)

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

Constructs a new Volume.

Parameter
NameDescription
properties IVolume

Properties to set

Properties

deviceName

public deviceName?: (string|null);

Volume deviceName.

gcs

public gcs?: (google.cloud.batch.v1.IGCS|null);

Volume gcs.

mountOptions

public mountOptions: string[];

Volume mountOptions.

mountPath

public mountPath: string;

Volume mountPath.

nfs

public nfs?: (google.cloud.batch.v1.INFS|null);

Volume nfs.

source

public source?: ("nfs"|"gcs"|"deviceName");

Volume source.

Methods

create(properties)

public static create(properties?: google.cloud.batch.v1.IVolume): google.cloud.batch.v1.Volume;

Creates a new Volume instance using the specified properties.

Parameter
NameDescription
properties IVolume

Properties to set

Returns
TypeDescription
Volume

Volume instance

decode(reader, length)

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

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

Volume

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Volume

Volume

encode(message, writer)

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

Encodes the specified Volume message. Does not implicitly messages.

Parameters
NameDescription
message IVolume

Volume 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.IVolume, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IVolume

Volume 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.Volume;

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

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

Plain object

Returns
TypeDescription
Volume

Volume

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Volume

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Volume

Volume

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