Represents a Volume.
Package
@google-cloud/bare-metal-solutionConstructors
(constructor)(properties)
constructor(properties?: google.cloud.baremetalsolution.v2.IVolume);Constructs a new Volume.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVolume
Properties to set |
Properties
autoGrownSizeGib
public autoGrownSizeGib: (number|Long|string);Volume autoGrownSizeGib.
currentSizeGib
public currentSizeGib: (number|Long|string);Volume currentSizeGib.
emergencySizeGib
public emergencySizeGib: (number|Long|string);Volume emergencySizeGib.
id
public id: string;Volume id.
labels
public labels: { [k: string]: string };Volume labels.
name
public name: string;Volume name.
pod
public pod: string;Volume pod.
remainingSpaceGib
public remainingSpaceGib: (number|Long|string);Volume remainingSpaceGib.
requestedSizeGib
public requestedSizeGib: (number|Long|string);Volume requestedSizeGib.
snapshotAutoDeleteBehavior
public snapshotAutoDeleteBehavior: (google.cloud.baremetalsolution.v2.Volume.SnapshotAutoDeleteBehavior|keyof typeof google.cloud.baremetalsolution.v2.Volume.SnapshotAutoDeleteBehavior);Volume snapshotAutoDeleteBehavior.
snapshotEnabled
public snapshotEnabled: boolean;Volume snapshotEnabled.
snapshotReservationDetail
public snapshotReservationDetail?: (google.cloud.baremetalsolution.v2.Volume.ISnapshotReservationDetail|null);Volume snapshotReservationDetail.
state
public state: (google.cloud.baremetalsolution.v2.Volume.State|keyof typeof google.cloud.baremetalsolution.v2.Volume.State);Volume state.
storageType
public storageType: (google.cloud.baremetalsolution.v2.Volume.StorageType|keyof typeof google.cloud.baremetalsolution.v2.Volume.StorageType);Volume storageType.
Methods
create(properties)
public static create(properties?: google.cloud.baremetalsolution.v2.IVolume): google.cloud.baremetalsolution.v2.Volume;Creates a new Volume instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVolume
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.baremetalsolution.v2.Volume | Volume instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.baremetalsolution.v2.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.baremetalsolution.v2.Volume | Volume |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.baremetalsolution.v2.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.baremetalsolution.v2.Volume | Volume |
encode(message, writer)
public static encode(message: google.cloud.baremetalsolution.v2.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.baremetalsolution.v2.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.baremetalsolution.v2.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.baremetalsolution.v2.Volume | Volume |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Volume
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
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.baremetalsolution.v2.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.baremetalsolution.v2.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) |
|