Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.notebooks.v1.RuntimeSoftwareConfig (2.1.4)

Represents a RuntimeSoftwareConfig.

Package

@google-cloud/notebooks

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.notebooks.v1.IRuntimeSoftwareConfig);

Constructs a new RuntimeSoftwareConfig.

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

Properties

_disableTerminal

public _disableTerminal?: "disableTerminal";

RuntimeSoftwareConfig _disableTerminal.

_enableHealthMonitoring

public _enableHealthMonitoring?: "enableHealthMonitoring";

RuntimeSoftwareConfig _enableHealthMonitoring.

_idleShutdown

public _idleShutdown?: "idleShutdown";

RuntimeSoftwareConfig _idleShutdown.

_upgradeable

public _upgradeable?: "upgradeable";

RuntimeSoftwareConfig _upgradeable.

_version

public _version?: "version";

RuntimeSoftwareConfig _version.

customGpuDriverPath

public customGpuDriverPath: string;

RuntimeSoftwareConfig customGpuDriverPath.

disableTerminal

public disableTerminal?: (boolean|null);

RuntimeSoftwareConfig disableTerminal.

enableHealthMonitoring

public enableHealthMonitoring?: (boolean|null);

RuntimeSoftwareConfig enableHealthMonitoring.

idleShutdown

public idleShutdown?: (boolean|null);

RuntimeSoftwareConfig idleShutdown.

idleShutdownTimeout

public idleShutdownTimeout: number;

RuntimeSoftwareConfig idleShutdownTimeout.

installGpuDriver

public installGpuDriver: boolean;

RuntimeSoftwareConfig installGpuDriver.

kernels

public kernels: google.cloud.notebooks.v1.IContainerImage[];

RuntimeSoftwareConfig kernels.

notebookUpgradeSchedule

public notebookUpgradeSchedule: string;

RuntimeSoftwareConfig notebookUpgradeSchedule.

postStartupScript

public postStartupScript: string;

RuntimeSoftwareConfig postStartupScript.

postStartupScriptBehavior

public postStartupScriptBehavior: (google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior|keyof typeof google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior);

RuntimeSoftwareConfig postStartupScriptBehavior.

upgradeable

public upgradeable?: (boolean|null);

RuntimeSoftwareConfig upgradeable.

version

public version?: (string|null);

RuntimeSoftwareConfig version.

Methods

create(properties)

public static create(properties?: google.cloud.notebooks.v1.IRuntimeSoftwareConfig): google.cloud.notebooks.v1.RuntimeSoftwareConfig;

Creates a new RuntimeSoftwareConfig instance using the specified properties.

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

Returns
Type	Description
`google.cloud.notebooks.v1.RuntimeSoftwareConfig`	RuntimeSoftwareConfig instance

decode(reader, length)

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

Decodes a RuntimeSoftwareConfig message from the specified reader or buffer.

Parameters
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`google.cloud.notebooks.v1.RuntimeSoftwareConfig`	RuntimeSoftwareConfig

decodeDelimited(reader)

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

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

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

Returns
Type	Description
`google.cloud.notebooks.v1.RuntimeSoftwareConfig`	RuntimeSoftwareConfig

encode(message, writer)

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

Encodes the specified RuntimeSoftwareConfig message. Does not implicitly messages.

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

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

Parameters
Name	Description
`message`	`IRuntimeSoftwareConfig` RuntimeSoftwareConfig 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.notebooks.v1.RuntimeSoftwareConfig;

Creates a RuntimeSoftwareConfig 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
`google.cloud.notebooks.v1.RuntimeSoftwareConfig`	RuntimeSoftwareConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for RuntimeSoftwareConfig

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

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`google.cloud.notebooks.v1.RuntimeSoftwareConfig` RuntimeSoftwareConfig
`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 RuntimeSoftwareConfig 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