Class protos.google.cloud.baremetalsolution.v2.ProvisioningConfig (1.1.0)

Represents a ProvisioningConfig.

Package

@google-cloud/bare-metal-solution

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.baremetalsolution.v2.IProvisioningConfig);

Constructs a new ProvisioningConfig.

Parameter
NameDescription
properties IProvisioningConfig

Properties to set

Properties

cloudConsoleUri

public cloudConsoleUri: string;

ProvisioningConfig cloudConsoleUri.

customId

public customId: string;

ProvisioningConfig customId.

email

public email: string;

ProvisioningConfig email.

handoverServiceAccount

public handoverServiceAccount: string;

ProvisioningConfig handoverServiceAccount.

instances

public instances: google.cloud.baremetalsolution.v2.IInstanceConfig[];

ProvisioningConfig instances.

location

public location: string;

ProvisioningConfig location.

name

public name: string;

ProvisioningConfig name.

networks

public networks: google.cloud.baremetalsolution.v2.INetworkConfig[];

ProvisioningConfig networks.

state

public state: (google.cloud.baremetalsolution.v2.ProvisioningConfig.State|keyof typeof google.cloud.baremetalsolution.v2.ProvisioningConfig.State);

ProvisioningConfig state.

statusMessage

public statusMessage: string;

ProvisioningConfig statusMessage.

ticketId

public ticketId: string;

ProvisioningConfig ticketId.

updateTime

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

ProvisioningConfig updateTime.

volumes

public volumes: google.cloud.baremetalsolution.v2.IVolumeConfig[];

ProvisioningConfig volumes.

vpcScEnabled

public vpcScEnabled: boolean;

ProvisioningConfig vpcScEnabled.

Methods

create(properties)

public static create(properties?: google.cloud.baremetalsolution.v2.IProvisioningConfig): google.cloud.baremetalsolution.v2.ProvisioningConfig;

Creates a new ProvisioningConfig instance using the specified properties.

Parameter
NameDescription
properties IProvisioningConfig

Properties to set

Returns
TypeDescription
ProvisioningConfig

ProvisioningConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.baremetalsolution.v2.ProvisioningConfig;

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

ProvisioningConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.baremetalsolution.v2.ProvisioningConfig;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
ProvisioningConfig

ProvisioningConfig

encode(message, writer)

public static encode(message: google.cloud.baremetalsolution.v2.IProvisioningConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ProvisioningConfig message. Does not implicitly messages.

Parameters
NameDescription
message IProvisioningConfig

ProvisioningConfig 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.baremetalsolution.v2.IProvisioningConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IProvisioningConfig

ProvisioningConfig 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.baremetalsolution.v2.ProvisioningConfig;

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

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

Plain object

Returns
TypeDescription
ProvisioningConfig

ProvisioningConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ProvisioningConfig

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message ProvisioningConfig

ProvisioningConfig

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