Represents an Instance.
Package
@google-cloud/notebooks!Constructors
(constructor)(properties)
constructor(properties?: google.cloud.notebooks.v1beta1.IInstance);
Constructs a new Instance.
Name | Description |
properties |
IInstance
Properties to set |
Properties
acceleratorConfig
public acceleratorConfig?: (google.cloud.notebooks.v1beta1.Instance.IAcceleratorConfig|null);
Instance acceleratorConfig.
Type | Description |
(google.cloud.notebooks.v1beta1.Instance.IAcceleratorConfig|null) |
bootDiskSizeGb
public bootDiskSizeGb: (number|Long|string);
Instance bootDiskSizeGb.
Type | Description |
(number|Long|string) |
bootDiskType
public bootDiskType: (google.cloud.notebooks.v1beta1.Instance.DiskType|keyof typeof google.cloud.notebooks.v1beta1.Instance.DiskType);
Instance bootDiskType.
Type | Description |
(google.cloud.notebooks.v1beta1.Instance.DiskType|keyof typeof google.cloud.notebooks.v1beta1.Instance.DiskType) |
containerImage
public containerImage?: (google.cloud.notebooks.v1beta1.IContainerImage|null);
Instance containerImage.
Type | Description |
(google.cloud.notebooks.v1beta1.IContainerImage|null) |
createTime
public createTime?: (google.protobuf.ITimestamp|null);
Instance createTime.
Type | Description |
(google.protobuf.ITimestamp|null) |
customGpuDriverPath
public customGpuDriverPath: string;
Instance customGpuDriverPath.
Type | Description |
string |
dataDiskSizeGb
public dataDiskSizeGb: (number|Long|string);
Instance dataDiskSizeGb.
Type | Description |
(number|Long|string) |
dataDiskType
public dataDiskType: (google.cloud.notebooks.v1beta1.Instance.DiskType|keyof typeof google.cloud.notebooks.v1beta1.Instance.DiskType);
Instance dataDiskType.
Type | Description |
(google.cloud.notebooks.v1beta1.Instance.DiskType|keyof typeof google.cloud.notebooks.v1beta1.Instance.DiskType) |
diskEncryption
public diskEncryption: (google.cloud.notebooks.v1beta1.Instance.DiskEncryption|keyof typeof google.cloud.notebooks.v1beta1.Instance.DiskEncryption);
Instance diskEncryption.
Type | Description |
(google.cloud.notebooks.v1beta1.Instance.DiskEncryption|keyof typeof google.cloud.notebooks.v1beta1.Instance.DiskEncryption) |
environment
public environment?: ("vmImage"|"containerImage");
Instance environment.
Type | Description |
("vmImage"|"containerImage") |
installGpuDriver
public installGpuDriver: boolean;
Instance installGpuDriver.
Type | Description |
boolean |
instanceOwners
public instanceOwners: string[];
Instance instanceOwners.
Type | Description |
string[] |
kmsKey
public kmsKey: string;
Instance kmsKey.
Type | Description |
string |
labels
public labels: { [k: string]: string };
Instance labels.
Type | Description |
{ [k: string]: string } |
machineType
public machineType: string;
Instance machineType.
Type | Description |
string |
metadata
public metadata: { [k: string]: string };
Instance metadata.
Type | Description |
{ [k: string]: string } |
name
public name: string;
Instance name.
Type | Description |
string |
network
public network: string;
Instance network.
Type | Description |
string |
noProxyAccess
public noProxyAccess: boolean;
Instance noProxyAccess.
Type | Description |
boolean |
noPublicIp
public noPublicIp: boolean;
Instance noPublicIp.
Type | Description |
boolean |
noRemoveDataDisk
public noRemoveDataDisk: boolean;
Instance noRemoveDataDisk.
Type | Description |
boolean |
postStartupScript
public postStartupScript: string;
Instance postStartupScript.
Type | Description |
string |
proxyUri
public proxyUri: string;
Instance proxyUri.
Type | Description |
string |
serviceAccount
public serviceAccount: string;
Instance serviceAccount.
Type | Description |
string |
state
public state: (google.cloud.notebooks.v1beta1.Instance.State|keyof typeof google.cloud.notebooks.v1beta1.Instance.State);
Instance state.
Type | Description |
(google.cloud.notebooks.v1beta1.Instance.State|keyof typeof google.cloud.notebooks.v1beta1.Instance.State) |
subnet
public subnet: string;
Instance subnet.
Type | Description |
string |
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);
Instance updateTime.
Type | Description |
(google.protobuf.ITimestamp|null) |
vmImage
public vmImage?: (google.cloud.notebooks.v1beta1.IVmImage|null);
Instance vmImage.
Type | Description |
(google.cloud.notebooks.v1beta1.IVmImage|null) |
Methods
create(properties)
public static create(properties?: google.cloud.notebooks.v1beta1.IInstance): google.cloud.notebooks.v1beta1.Instance;
Creates a new Instance instance using the specified properties.
Name | Description |
properties |
IInstance
Properties to set |
Type | Description |
google.cloud.notebooks.v1beta1.Instance | Instance instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1beta1.Instance;
Decodes an Instance message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
google.cloud.notebooks.v1beta1.Instance | Instance |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1beta1.Instance;
Decodes an Instance message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.cloud.notebooks.v1beta1.Instance | Instance |
encode(message, writer)
public static encode(message: google.cloud.notebooks.v1beta1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Instance message. Does not implicitly messages.
Name | Description |
message |
IInstance
Instance message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.notebooks.v1beta1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Instance message, length delimited. Does not implicitly messages.
Name | Description |
message |
IInstance
Instance message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.notebooks.v1beta1.Instance;
Creates an Instance message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.cloud.notebooks.v1beta1.Instance | Instance |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Instance to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.notebooks.v1beta1.Instance, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an Instance message. Also converts values to other types if specified.
Name | Description |
message |
google.cloud.notebooks.v1beta1.Instance
Instance |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies an Instance message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|