Class protos.google.cloud.gdchardwaremanagement.v1alpha.Hardware (0.7.0)

Represents a Hardware.

Package

@google-cloud/gdchardwaremanagement

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.gdchardwaremanagement.v1alpha.IHardware);

Constructs a new Hardware.

Parameter
Name Description
properties IHardware

Properties to set

Properties

actualInstallationDate

public actualInstallationDate?: (google.type.IDate|null);

Hardware actualInstallationDate.

ciqUri

public ciqUri: string;

Hardware ciqUri.

config

public config?: (google.cloud.gdchardwaremanagement.v1alpha.IHardwareConfig|null);

Hardware config.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Hardware createTime.

displayName

public displayName: string;

Hardware displayName.

estimatedInstallationDate

public estimatedInstallationDate?: (google.type.IDate|null);

Hardware estimatedInstallationDate.

hardwareGroup

public hardwareGroup: string;

Hardware hardwareGroup.

installationInfo

public installationInfo?: (google.cloud.gdchardwaremanagement.v1alpha.IHardwareInstallationInfo|null);

Hardware installationInfo.

labels

public labels: { [k: string]: string };

Hardware labels.

machineInfos

public machineInfos: google.cloud.gdchardwaremanagement.v1alpha.Hardware.IMachineInfo[];

Hardware machineInfos.

name

public name: string;

Hardware name.

order

public order: string;

Hardware order.

physicalInfo

public physicalInfo?: (google.cloud.gdchardwaremanagement.v1alpha.IHardwarePhysicalInfo|null);

Hardware physicalInfo.

requestedInstallationDate

public requestedInstallationDate?: (google.type.IDate|null);

Hardware requestedInstallationDate.

site

public site: string;

Hardware site.

state

public state: (google.cloud.gdchardwaremanagement.v1alpha.Hardware.State|keyof typeof google.cloud.gdchardwaremanagement.v1alpha.Hardware.State);

Hardware state.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Hardware updateTime.

zone

public zone: string;

Hardware zone.

Methods

create(properties)

public static create(properties?: google.cloud.gdchardwaremanagement.v1alpha.IHardware): google.cloud.gdchardwaremanagement.v1alpha.Hardware;

Creates a new Hardware instance using the specified properties.

Parameter
Name Description
properties IHardware

Properties to set

Returns
Type Description
Hardware

Hardware instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.gdchardwaremanagement.v1alpha.Hardware;

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

Hardware

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gdchardwaremanagement.v1alpha.Hardware;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Hardware

Hardware

encode(message, writer)

public static encode(message: google.cloud.gdchardwaremanagement.v1alpha.IHardware, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Hardware message. Does not implicitly messages.

Parameters
Name Description
message IHardware

Hardware 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.gdchardwaremanagement.v1alpha.IHardware, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IHardware

Hardware 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.gdchardwaremanagement.v1alpha.Hardware;

Creates a Hardware 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
Hardware

Hardware

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Hardware

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Hardware

Hardware

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