Class protos.google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate (6.4.0)

Represents a NotebookRuntimeTemplate.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1beta1.INotebookRuntimeTemplate);

Constructs a new NotebookRuntimeTemplate.

Parameter
Name Description
properties INotebookRuntimeTemplate

Properties to set

Properties

createTime

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

NotebookRuntimeTemplate createTime.

dataPersistentDiskSpec

public dataPersistentDiskSpec?: (google.cloud.aiplatform.v1beta1.IPersistentDiskSpec|null);

NotebookRuntimeTemplate dataPersistentDiskSpec.

description

public description: string;

NotebookRuntimeTemplate description.

displayName

public displayName: string;

NotebookRuntimeTemplate displayName.

encryptionSpec

public encryptionSpec?: (google.cloud.aiplatform.v1beta1.IEncryptionSpec|null);

NotebookRuntimeTemplate encryptionSpec.

etag

public etag: string;

NotebookRuntimeTemplate etag.

eucConfig

public eucConfig?: (google.cloud.aiplatform.v1beta1.INotebookEucConfig|null);

NotebookRuntimeTemplate eucConfig.

idleShutdownConfig

public idleShutdownConfig?: (google.cloud.aiplatform.v1beta1.INotebookIdleShutdownConfig|null);

NotebookRuntimeTemplate idleShutdownConfig.

isDefault

public isDefault: boolean;

NotebookRuntimeTemplate isDefault.

labels

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

NotebookRuntimeTemplate labels.

machineSpec

public machineSpec?: (google.cloud.aiplatform.v1beta1.IMachineSpec|null);

NotebookRuntimeTemplate machineSpec.

name

public name: string;

NotebookRuntimeTemplate name.

networkSpec

public networkSpec?: (google.cloud.aiplatform.v1beta1.INetworkSpec|null);

NotebookRuntimeTemplate networkSpec.

networkTags

public networkTags: string[];

NotebookRuntimeTemplate networkTags.

notebookRuntimeType

public notebookRuntimeType: (google.cloud.aiplatform.v1beta1.NotebookRuntimeType|keyof typeof google.cloud.aiplatform.v1beta1.NotebookRuntimeType);

NotebookRuntimeTemplate notebookRuntimeType.

serviceAccount

public serviceAccount: string;

NotebookRuntimeTemplate serviceAccount.

shieldedVmConfig

public shieldedVmConfig?: (google.cloud.aiplatform.v1beta1.IShieldedVmConfig|null);

NotebookRuntimeTemplate shieldedVmConfig.

softwareConfig

public softwareConfig?: (google.cloud.aiplatform.v1beta1.INotebookSoftwareConfig|null);

NotebookRuntimeTemplate softwareConfig.

updateTime

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

NotebookRuntimeTemplate updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1beta1.INotebookRuntimeTemplate): google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate;

Creates a new NotebookRuntimeTemplate instance using the specified properties.

Parameter
Name Description
properties INotebookRuntimeTemplate

Properties to set

Returns
Type Description
NotebookRuntimeTemplate

NotebookRuntimeTemplate instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate;

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

NotebookRuntimeTemplate

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
NotebookRuntimeTemplate

NotebookRuntimeTemplate

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1beta1.INotebookRuntimeTemplate, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified NotebookRuntimeTemplate message. Does not implicitly messages.

Parameters
Name Description
message INotebookRuntimeTemplate

NotebookRuntimeTemplate 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.v1beta1.INotebookRuntimeTemplate, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message INotebookRuntimeTemplate

NotebookRuntimeTemplate 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.v1beta1.NotebookRuntimeTemplate;

Creates a NotebookRuntimeTemplate 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
NotebookRuntimeTemplate

NotebookRuntimeTemplate

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for NotebookRuntimeTemplate

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message NotebookRuntimeTemplate

NotebookRuntimeTemplate

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