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

Represents a WorkstationConfig.

Package

Constructors

(constructor)(properties)

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

Constructs a new WorkstationConfig.

Parameter
Name	Description
`properties`	`IWorkstationConfig` Properties to set

Properties

annotations

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

WorkstationConfig annotations.

conditions

public conditions: google.rpc.IStatus[];

WorkstationConfig conditions.

container

public container?: (google.cloud.workstations.v1.WorkstationConfig.IContainer|null);

WorkstationConfig container.

createTime

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

WorkstationConfig createTime.

degraded

public degraded: boolean;

WorkstationConfig degraded.

deleteTime

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

WorkstationConfig deleteTime.

displayName

public displayName: string;

WorkstationConfig displayName.

encryptionKey

public encryptionKey?: (google.cloud.workstations.v1.WorkstationConfig.ICustomerEncryptionKey|null);

WorkstationConfig encryptionKey.

etag

public etag: string;

WorkstationConfig etag.

host

public host?: (google.cloud.workstations.v1.WorkstationConfig.IHost|null);

WorkstationConfig host.

idleTimeout

public idleTimeout?: (google.protobuf.IDuration|null);

WorkstationConfig idleTimeout.

labels

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

WorkstationConfig labels.

name

public name: string;

WorkstationConfig name.

persistentDirectories

public persistentDirectories: google.cloud.workstations.v1.WorkstationConfig.IPersistentDirectory[];

WorkstationConfig persistentDirectories.

readinessChecks

public readinessChecks: google.cloud.workstations.v1.WorkstationConfig.IReadinessCheck[];

WorkstationConfig readinessChecks.

reconciling

public reconciling: boolean;

WorkstationConfig reconciling.

replicaZones

public replicaZones: string[];

WorkstationConfig replicaZones.

runningTimeout

public runningTimeout?: (google.protobuf.IDuration|null);

WorkstationConfig runningTimeout.

uid

public uid: string;

WorkstationConfig uid.

updateTime

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

WorkstationConfig updateTime.

Methods

create(properties)

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

Creates a new WorkstationConfig instance using the specified properties.

Parameter
Name	Description
`properties`	`IWorkstationConfig` Properties to set

Returns
Type	Description
`WorkstationConfig`	WorkstationConfig instance

decode(reader, length)

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

Decodes a WorkstationConfig 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
`WorkstationConfig`	WorkstationConfig

decodeDelimited(reader)

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

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`WorkstationConfig`	WorkstationConfig

encode(message, writer)

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

Encodes the specified WorkstationConfig message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IWorkstationConfig` WorkstationConfig 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.workstations.v1.IWorkstationConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IWorkstationConfig` WorkstationConfig 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.workstations.v1.WorkstationConfig;

Creates a WorkstationConfig 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
`WorkstationConfig`	WorkstationConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for WorkstationConfig

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

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`WorkstationConfig` WorkstationConfig
`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 WorkstationConfig 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