Represents a VolumeConfig.
Package
@google-cloud/bare-metal-solutionConstructors
(constructor)(properties)
constructor(properties?: google.cloud.baremetalsolution.v2.IVolumeConfig);Constructs a new VolumeConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVolumeConfig
Properties to set |
Properties
gcpService
public gcpService: string;VolumeConfig gcpService.
id
public id: string;VolumeConfig id.
lunRanges
public lunRanges: google.cloud.baremetalsolution.v2.VolumeConfig.ILunRange[];VolumeConfig lunRanges.
machineIds
public machineIds: string[];VolumeConfig machineIds.
name
public name: string;VolumeConfig name.
nfsExports
public nfsExports: google.cloud.baremetalsolution.v2.VolumeConfig.INfsExport[];VolumeConfig nfsExports.
performanceTier
public performanceTier: (google.cloud.baremetalsolution.v2.VolumePerformanceTier|keyof typeof google.cloud.baremetalsolution.v2.VolumePerformanceTier);VolumeConfig performanceTier.
protocol
public protocol: (google.cloud.baremetalsolution.v2.VolumeConfig.Protocol|keyof typeof google.cloud.baremetalsolution.v2.VolumeConfig.Protocol);VolumeConfig protocol.
sizeGb
public sizeGb: number;VolumeConfig sizeGb.
snapshotsEnabled
public snapshotsEnabled: boolean;VolumeConfig snapshotsEnabled.
type
public type: (google.cloud.baremetalsolution.v2.VolumeConfig.Type|keyof typeof google.cloud.baremetalsolution.v2.VolumeConfig.Type);VolumeConfig type.
userNote
public userNote: string;VolumeConfig userNote.
Methods
create(properties)
public static create(properties?: google.cloud.baremetalsolution.v2.IVolumeConfig): google.cloud.baremetalsolution.v2.VolumeConfig;Creates a new VolumeConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVolumeConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
VolumeConfig |
VolumeConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.baremetalsolution.v2.VolumeConfig;Decodes a VolumeConfig message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
VolumeConfig |
VolumeConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.baremetalsolution.v2.VolumeConfig;Decodes a VolumeConfig message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
VolumeConfig |
VolumeConfig |
encode(message, writer)
public static encode(message: google.cloud.baremetalsolution.v2.IVolumeConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified VolumeConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVolumeConfig
VolumeConfig 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.IVolumeConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified VolumeConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVolumeConfig
VolumeConfig 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.VolumeConfig;Creates a VolumeConfig 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 |
VolumeConfig |
VolumeConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for VolumeConfig
| 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 VolumeConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.baremetalsolution.v2.VolumeConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a VolumeConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
VolumeConfig
VolumeConfig |
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 VolumeConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|