Class protos.google.cloud.workstations.v1.WorkstationConfig.Host (1.1.1)

Represents a Host.

Package

@google-cloud/workstations

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.workstations.v1.WorkstationConfig.IHost);

Constructs a new Host.

Parameter
NameDescription
properties IHost

Properties to set

Properties

config

public config?: "gceInstance";

Host config.

gceInstance

public gceInstance?: (google.cloud.workstations.v1.WorkstationConfig.Host.IGceInstance|null);

Host gceInstance.

Methods

create(properties)

public static create(properties?: google.cloud.workstations.v1.WorkstationConfig.IHost): google.cloud.workstations.v1.WorkstationConfig.Host;

Creates a new Host instance using the specified properties.

Parameter
NameDescription
properties IHost

Properties to set

Returns
TypeDescription
Host

Host instance

decode(reader, length)

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

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

Host

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.workstations.v1.WorkstationConfig.Host;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Host

Host

encode(message, writer)

public static encode(message: google.cloud.workstations.v1.WorkstationConfig.IHost, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Host message. Does not implicitly messages.

Parameters
NameDescription
message IHost

Host 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.workstations.v1.WorkstationConfig.IHost, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IHost

Host 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.workstations.v1.WorkstationConfig.Host;

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

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

Plain object

Returns
TypeDescription
Host

Host

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Host

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Host

Host

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