Represents an Instance.
Package
@google-cloud/bare-metal-solutionConstructors
(constructor)(properties)
constructor(properties?: google.cloud.baremetalsolution.v2.IInstance);
Constructs a new Instance.
Parameter | |
---|---|
Name | Description |
properties |
IInstance
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);
Instance createTime.
firmwareVersion
public firmwareVersion: string;
Instance firmwareVersion.
hyperthreadingEnabled
public hyperthreadingEnabled: boolean;
Instance hyperthreadingEnabled.
id
public id: string;
Instance id.
interactiveSerialConsoleEnabled
public interactiveSerialConsoleEnabled: boolean;
Instance interactiveSerialConsoleEnabled.
labels
public labels: { [k: string]: string };
Instance labels.
logicalInterfaces
public logicalInterfaces: google.cloud.baremetalsolution.v2.ILogicalInterface[];
Instance logicalInterfaces.
loginInfo
public loginInfo: string;
Instance loginInfo.
luns
public luns: google.cloud.baremetalsolution.v2.ILun[];
Instance luns.
machineType
public machineType: string;
Instance machineType.
name
public name: string;
Instance name.
networks
public networks: google.cloud.baremetalsolution.v2.INetwork[];
Instance networks.
networkTemplate
public networkTemplate: string;
Instance networkTemplate.
osImage
public osImage: string;
Instance osImage.
pod
public pod: string;
Instance pod.
state
public state: (google.cloud.baremetalsolution.v2.Instance.State|keyof typeof google.cloud.baremetalsolution.v2.Instance.State);
Instance state.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);
Instance updateTime.
volumes
public volumes: google.cloud.baremetalsolution.v2.IVolume[];
Instance volumes.
workloadProfile
public workloadProfile: (google.cloud.baremetalsolution.v2.WorkloadProfile|keyof typeof google.cloud.baremetalsolution.v2.WorkloadProfile);
Instance workloadProfile.
Methods
create(properties)
public static create(properties?: google.cloud.baremetalsolution.v2.IInstance): google.cloud.baremetalsolution.v2.Instance;
Creates a new Instance instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IInstance
Properties to set |
Returns | |
---|---|
Type | Description |
Instance | Instance instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.baremetalsolution.v2.Instance;
Decodes an Instance 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 |
Instance | Instance |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.baremetalsolution.v2.Instance;
Decodes an Instance message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Instance | Instance |
encode(message, writer)
public static encode(message: google.cloud.baremetalsolution.v2.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Instance message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IInstance
Instance 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.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Instance message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IInstance
Instance 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.Instance;
Creates an Instance 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 |
Instance | Instance |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Instance
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 Instance to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.baremetalsolution.v2.Instance, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an Instance message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Instance
Instance |
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 an Instance message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|