Class protos.google.cloud.dataproc.v1.SessionTemplate (5.4.0)

Represents a SessionTemplate.

Package

@google-cloud/dataproc

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataproc.v1.ISessionTemplate);

Constructs a new SessionTemplate.

Parameter
NameDescription
properties ISessionTemplate

Properties to set

Properties

createTime

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

SessionTemplate createTime.

creator

public creator: string;

SessionTemplate creator.

description

public description: string;

SessionTemplate description.

environmentConfig

public environmentConfig?: (google.cloud.dataproc.v1.IEnvironmentConfig|null);

SessionTemplate environmentConfig.

jupyterSession

public jupyterSession?: (google.cloud.dataproc.v1.IJupyterConfig|null);

SessionTemplate jupyterSession.

labels

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

SessionTemplate labels.

name

public name: string;

SessionTemplate name.

runtimeConfig

public runtimeConfig?: (google.cloud.dataproc.v1.IRuntimeConfig|null);

SessionTemplate runtimeConfig.

sessionConfig

public sessionConfig?: "jupyterSession";

SessionTemplate sessionConfig.

updateTime

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

SessionTemplate updateTime.

uuid

public uuid: string;

SessionTemplate uuid.

Methods

create(properties)

public static create(properties?: google.cloud.dataproc.v1.ISessionTemplate): google.cloud.dataproc.v1.SessionTemplate;

Creates a new SessionTemplate instance using the specified properties.

Parameter
NameDescription
properties ISessionTemplate

Properties to set

Returns
TypeDescription
SessionTemplate

SessionTemplate instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataproc.v1.SessionTemplate;

Decodes a SessionTemplate message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
SessionTemplate

SessionTemplate

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataproc.v1.SessionTemplate;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
SessionTemplate

SessionTemplate

encode(message, writer)

public static encode(message: google.cloud.dataproc.v1.ISessionTemplate, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SessionTemplate message. Does not implicitly messages.

Parameters
NameDescription
message ISessionTemplate

SessionTemplate message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.dataproc.v1.ISessionTemplate, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISessionTemplate

SessionTemplate message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dataproc.v1.SessionTemplate;

Creates a SessionTemplate message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
SessionTemplate

SessionTemplate

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SessionTemplate

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this SessionTemplate to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message SessionTemplate

SessionTemplate

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a SessionTemplate message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not