Represents a NotebookRuntime.
Package
@google-cloud/aiplatformConstructors
(constructor)(properties)
constructor(properties?: google.cloud.aiplatform.v1.INotebookRuntime);Constructs a new NotebookRuntime.
| Parameter | |
|---|---|
| Name | Description |
properties |
INotebookRuntime
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);NotebookRuntime createTime.
dataPersistentDiskSpec
public dataPersistentDiskSpec?: (google.cloud.aiplatform.v1.IPersistentDiskSpec|null);NotebookRuntime dataPersistentDiskSpec.
description
public description: string;NotebookRuntime description.
displayName
public displayName: string;NotebookRuntime displayName.
encryptionSpec
public encryptionSpec?: (google.cloud.aiplatform.v1.IEncryptionSpec|null);NotebookRuntime encryptionSpec.
eucConfig
public eucConfig?: (google.cloud.aiplatform.v1.INotebookEucConfig|null);NotebookRuntime eucConfig.
expirationTime
public expirationTime?: (google.protobuf.ITimestamp|null);NotebookRuntime expirationTime.
healthState
public healthState: (google.cloud.aiplatform.v1.NotebookRuntime.HealthState|keyof typeof google.cloud.aiplatform.v1.NotebookRuntime.HealthState);NotebookRuntime healthState.
idleShutdownConfig
public idleShutdownConfig?: (google.cloud.aiplatform.v1.INotebookIdleShutdownConfig|null);NotebookRuntime idleShutdownConfig.
isUpgradable
public isUpgradable: boolean;NotebookRuntime isUpgradable.
labels
public labels: { [k: string]: string };NotebookRuntime labels.
machineSpec
public machineSpec?: (google.cloud.aiplatform.v1.IMachineSpec|null);NotebookRuntime machineSpec.
name
public name: string;NotebookRuntime name.
networkSpec
public networkSpec?: (google.cloud.aiplatform.v1.INetworkSpec|null);NotebookRuntime networkSpec.
networkTags
public networkTags: string[];NotebookRuntime networkTags.
notebookRuntimeTemplateRef
public notebookRuntimeTemplateRef?: (google.cloud.aiplatform.v1.INotebookRuntimeTemplateRef|null);NotebookRuntime notebookRuntimeTemplateRef.
notebookRuntimeType
public notebookRuntimeType: (google.cloud.aiplatform.v1.NotebookRuntimeType|keyof typeof google.cloud.aiplatform.v1.NotebookRuntimeType);NotebookRuntime notebookRuntimeType.
proxyUri
public proxyUri: string;NotebookRuntime proxyUri.
runtimeState
public runtimeState: (google.cloud.aiplatform.v1.NotebookRuntime.RuntimeState|keyof typeof google.cloud.aiplatform.v1.NotebookRuntime.RuntimeState);NotebookRuntime runtimeState.
runtimeUser
public runtimeUser: string;NotebookRuntime runtimeUser.
satisfiesPzi
public satisfiesPzi: boolean;NotebookRuntime satisfiesPzi.
satisfiesPzs
public satisfiesPzs: boolean;NotebookRuntime satisfiesPzs.
serviceAccount
public serviceAccount: string;NotebookRuntime serviceAccount.
shieldedVmConfig
public shieldedVmConfig?: (google.cloud.aiplatform.v1.IShieldedVmConfig|null);NotebookRuntime shieldedVmConfig.
softwareConfig
public softwareConfig?: (google.cloud.aiplatform.v1.INotebookSoftwareConfig|null);NotebookRuntime softwareConfig.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);NotebookRuntime updateTime.
version
public version: string;NotebookRuntime version.
Methods
create(properties)
public static create(properties?: google.cloud.aiplatform.v1.INotebookRuntime): google.cloud.aiplatform.v1.NotebookRuntime;Creates a new NotebookRuntime instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
INotebookRuntime
Properties to set |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
NotebookRuntime instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.NotebookRuntime;Decodes a NotebookRuntime 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 |
NotebookRuntime |
NotebookRuntime |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.NotebookRuntime;Decodes a NotebookRuntime message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
NotebookRuntime |
encode(message, writer)
public static encode(message: google.cloud.aiplatform.v1.INotebookRuntime, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified NotebookRuntime message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
INotebookRuntime
NotebookRuntime 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.aiplatform.v1.INotebookRuntime, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified NotebookRuntime message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
INotebookRuntime
NotebookRuntime 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.aiplatform.v1.NotebookRuntime;Creates a NotebookRuntime 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 |
NotebookRuntime |
NotebookRuntime |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for NotebookRuntime
| 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 NotebookRuntime to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.aiplatform.v1.NotebookRuntime, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a NotebookRuntime message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
NotebookRuntime
NotebookRuntime |
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 NotebookRuntime message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|