Class protos.google.cloud.notebooks.v1beta1.Environment (1.3.1)

Version 1.3.1

• 2.1.4 (latest)
• 2.1.3
• 1.3.1
• 1.2.0
• 1.1.7

Represents an Environment.

Package

@google-cloud/notebooks

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.notebooks.v1beta1.IEnvironment);

Constructs a new Environment.

Parameter

Name	Description
properties	IEnvironment Properties to set

Properties

containerImage

public containerImage?: (google.cloud.notebooks.v1beta1.IContainerImage|null);

Environment containerImage.

createTime

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

Environment createTime.

description

public description: string;

Environment description.

displayName

public displayName: string;

Environment displayName.

imageType

public imageType?: ("vmImage"|"containerImage");

Environment imageType.

name

public name: string;

Environment name.

postStartupScript

public postStartupScript: string;

Environment postStartupScript.

vmImage

public vmImage?: (google.cloud.notebooks.v1beta1.IVmImage|null);

Environment vmImage.

Methods

create(properties)

public static create(properties?: google.cloud.notebooks.v1beta1.IEnvironment): google.cloud.notebooks.v1beta1.Environment;

Creates a new Environment instance using the specified properties.

Parameter

Name	Description
properties	IEnvironment Properties to set

Returns

Type	Description
google.cloud.notebooks.v1beta1.Environment	Environment instance

decode(reader, length)

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

Decodes an Environment 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.v1beta1.Environment	Environment

decodeDelimited(reader)

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

Decodes an Environment 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.v1beta1.Environment	Environment

encode(message, writer)

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

Encodes the specified Environment message. Does not implicitly messages.

Parameters

Name	Description
message	IEnvironment Environment 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.v1beta1.IEnvironment, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IEnvironment Environment 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.v1beta1.Environment;

Creates an Environment 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.v1beta1.Environment	Environment

toJSON()

public toJSON(): { [k: string]: any };

Converts this Environment to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.notebooks.v1beta1.Environment Environment
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 an Environment 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