Represents a Session.
Package
@google-cloud/dataprocConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataproc.v1.ISession);Constructs a new Session.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISession
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Session createTime.
creator
public creator: string;Session creator.
environmentConfig
public environmentConfig?: (google.cloud.dataproc.v1.IEnvironmentConfig|null);Session environmentConfig.
jupyterSession
public jupyterSession?: (google.cloud.dataproc.v1.IJupyterConfig|null);Session jupyterSession.
labels
public labels: { [k: string]: string };Session labels.
name
public name: string;Session name.
runtimeConfig
public runtimeConfig?: (google.cloud.dataproc.v1.IRuntimeConfig|null);Session runtimeConfig.
runtimeInfo
public runtimeInfo?: (google.cloud.dataproc.v1.IRuntimeInfo|null);Session runtimeInfo.
sessionConfig
public sessionConfig?: "jupyterSession";Session sessionConfig.
sessionTemplate
public sessionTemplate: string;Session sessionTemplate.
state
public state: (google.cloud.dataproc.v1.Session.State|keyof typeof google.cloud.dataproc.v1.Session.State);Session state.
stateHistory
public stateHistory: google.cloud.dataproc.v1.Session.ISessionStateHistory[];Session stateHistory.
stateMessage
public stateMessage: string;Session stateMessage.
stateTime
public stateTime?: (google.protobuf.ITimestamp|null);Session stateTime.
user
public user: string;Session user.
uuid
public uuid: string;Session uuid.
Methods
create(properties)
public static create(properties?: google.cloud.dataproc.v1.ISession): google.cloud.dataproc.v1.Session;Creates a new Session instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISession
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Session | Session instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataproc.v1.Session;Decodes a Session 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 |
Session | Session |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataproc.v1.Session;Decodes a Session message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Session | Session |
encode(message, writer)
public static encode(message: google.cloud.dataproc.v1.ISession, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Session message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISession
Session 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.dataproc.v1.ISession, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Session message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISession
Session 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.dataproc.v1.Session;Creates a Session 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 |
Session | Session |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Session
| 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 Session to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataproc.v1.Session, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Session message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Session
Session |
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 Session message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|