Class protos.google.cloud.vmwareengine.v1.PrivateCloud (1.0.2)

Represents a PrivateCloud.

Package

@google-cloud/vmwareengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vmwareengine.v1.IPrivateCloud);

Constructs a new PrivateCloud.

Parameter
NameDescription
properties IPrivateCloud

Properties to set

Properties

createTime

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

PrivateCloud createTime.

deleteTime

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

PrivateCloud deleteTime.

description

public description: string;

PrivateCloud description.

expireTime

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

PrivateCloud expireTime.

hcx

public hcx?: (google.cloud.vmwareengine.v1.IHcx|null);

PrivateCloud hcx.

managementCluster

public managementCluster?: (google.cloud.vmwareengine.v1.PrivateCloud.IManagementCluster|null);

PrivateCloud managementCluster.

name

public name: string;

PrivateCloud name.

networkConfig

public networkConfig?: (google.cloud.vmwareengine.v1.INetworkConfig|null);

PrivateCloud networkConfig.

nsx

public nsx?: (google.cloud.vmwareengine.v1.INsx|null);

PrivateCloud nsx.

state

public state: (google.cloud.vmwareengine.v1.PrivateCloud.State|keyof typeof google.cloud.vmwareengine.v1.PrivateCloud.State);

PrivateCloud state.

type

public type: (google.cloud.vmwareengine.v1.PrivateCloud.Type|keyof typeof google.cloud.vmwareengine.v1.PrivateCloud.Type);

PrivateCloud type.

uid

public uid: string;

PrivateCloud uid.

updateTime

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

PrivateCloud updateTime.

vcenter

public vcenter?: (google.cloud.vmwareengine.v1.IVcenter|null);

PrivateCloud vcenter.

Methods

create(properties)

public static create(properties?: google.cloud.vmwareengine.v1.IPrivateCloud): google.cloud.vmwareengine.v1.PrivateCloud;

Creates a new PrivateCloud instance using the specified properties.

Parameter
NameDescription
properties IPrivateCloud

Properties to set

Returns
TypeDescription
PrivateCloud

PrivateCloud instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.vmwareengine.v1.PrivateCloud;

Decodes a PrivateCloud message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
PrivateCloud

PrivateCloud

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.vmwareengine.v1.PrivateCloud;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
PrivateCloud

PrivateCloud

encode(message, writer)

public static encode(message: google.cloud.vmwareengine.v1.IPrivateCloud, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PrivateCloud message. Does not implicitly messages.

Parameters
NameDescription
message IPrivateCloud

PrivateCloud message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.vmwareengine.v1.IPrivateCloud, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IPrivateCloud

PrivateCloud message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.vmwareengine.v1.PrivateCloud;

Creates a PrivateCloud message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
PrivateCloud

PrivateCloud

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PrivateCloud

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this PrivateCloud to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message PrivateCloud

PrivateCloud

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a PrivateCloud message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not