Constructor
new Session(propertiesopt)
Constructs a new Session.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.dataproc.v1.ISession |
<optional> |
Properties to set |
- Implements:
-
- ISession
Classes
Members
createTime
Session createTime.
creator
Session creator.
environmentConfig
Session environmentConfig.
jupyterSession
Session jupyterSession.
labels
Session labels.
name
Session name.
runtimeConfig
Session runtimeConfig.
runtimeInfo
Session runtimeInfo.
sessionConfig
Session sessionConfig.
sessionTemplate
Session sessionTemplate.
state
Session state.
stateHistory
Session stateHistory.
stateMessage
Session stateMessage.
stateTime
Session stateTime.
user
Session user.
uuid
Session uuid.
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
CREATING |
number |
CREATING value |
ACTIVE |
number |
ACTIVE value |
TERMINATING |
number |
TERMINATING value |
TERMINATED |
number |
TERMINATED value |
FAILED |
number |
FAILED value |
Methods
toJSON() → {Object.<string, *>}
Converts this Session to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.dataproc.v1.Session}
Creates a new Session instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.dataproc.v1.ISession |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.dataproc.v1.Session |
Session instance |
(static) decode(reader, lengthopt) → {google.cloud.dataproc.v1.Session}
Decodes a Session message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.dataproc.v1.Session |
Session |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.dataproc.v1.Session}
Decodes a Session message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.dataproc.v1.Session |
Session |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Session message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dataproc.v1.ISession |
Session message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Session message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dataproc.v1.ISession |
Session message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.dataproc.v1.Session}
Creates a Session message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.dataproc.v1.Session |
Session |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Session
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Session message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.dataproc.v1.Session |
Session |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Session message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|