Represents a Runtime.
Package
@google-cloud/notebooksConstructors
(constructor)(properties)
constructor(properties?: google.cloud.notebooks.v1.IRuntime);Constructs a new Runtime.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRuntime
Properties to set |
Properties
accessConfig
public accessConfig?: (google.cloud.notebooks.v1.IRuntimeAccessConfig|null);Runtime accessConfig.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Runtime createTime.
healthState
public healthState: (google.cloud.notebooks.v1.Runtime.HealthState|keyof typeof google.cloud.notebooks.v1.Runtime.HealthState);Runtime healthState.
metrics
public metrics?: (google.cloud.notebooks.v1.IRuntimeMetrics|null);Runtime metrics.
name
public name: string;Runtime name.
runtimeType
public runtimeType?: "virtualMachine";Runtime runtimeType.
softwareConfig
public softwareConfig?: (google.cloud.notebooks.v1.IRuntimeSoftwareConfig|null);Runtime softwareConfig.
state
public state: (google.cloud.notebooks.v1.Runtime.State|keyof typeof google.cloud.notebooks.v1.Runtime.State);Runtime state.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Runtime updateTime.
virtualMachine
public virtualMachine?: (google.cloud.notebooks.v1.IVirtualMachine|null);Runtime virtualMachine.
Methods
create(properties)
public static create(properties?: google.cloud.notebooks.v1.IRuntime): google.cloud.notebooks.v1.Runtime;Creates a new Runtime instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRuntime
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.notebooks.v1.Runtime | Runtime instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1.Runtime;Decodes a Runtime 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.Runtime | Runtime |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1.Runtime;Decodes a Runtime 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.Runtime | Runtime |
encode(message, writer)
public static encode(message: google.cloud.notebooks.v1.IRuntime, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Runtime message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRuntime
Runtime 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.IRuntime, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Runtime message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRuntime
Runtime 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.Runtime;Creates a Runtime 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.Runtime | Runtime |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Runtime
| 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 Runtime to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.notebooks.v1.Runtime, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Runtime message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.notebooks.v1.Runtime
Runtime |
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 Runtime message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|