Class protos.google.cloud.lifesciences.v2beta.Volume (1.1.1)

Represents a Volume.

Package

@google-cloud/life-sciences

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.lifesciences.v2beta.IVolume);

Constructs a new Volume.

Parameter
Name Description
properties IVolume

Properties to set

Properties

existingDisk

public existingDisk?: (google.cloud.lifesciences.v2beta.IExistingDisk|null);

Volume existingDisk.

nfsMount

public nfsMount?: (google.cloud.lifesciences.v2beta.INFSMount|null);

Volume nfsMount.

persistentDisk

public persistentDisk?: (google.cloud.lifesciences.v2beta.IPersistentDisk|null);

Volume persistentDisk.

storage

public storage?: ("persistentDisk"|"existingDisk"|"nfsMount");

Volume storage.

volume

public volume: string;

Volume volume.

Methods

create(properties)

public static create(properties?: google.cloud.lifesciences.v2beta.IVolume): google.cloud.lifesciences.v2beta.Volume;

Creates a new Volume instance using the specified properties.

Parameter
Name Description
properties IVolume

Properties to set
Returns
Type Description
google.cloud.lifesciences.v2beta.Volume

Volume instance

decode(reader, length)

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

Decodes a Volume 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.lifesciences.v2beta.Volume

Volume

decodeDelimited(reader)

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

Decodes a Volume 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.lifesciences.v2beta.Volume

Volume

encode(message, writer)

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

Encodes the specified Volume message. Does not implicitly messages.

Parameters
Name Description
message IVolume

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

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

Parameters
Name Description
message IVolume

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

Creates a Volume 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.lifesciences.v2beta.Volume

Volume

toJSON()

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

Converts this Volume to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.lifesciences.v2beta.Volume

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