Constructor
new Execution(propertiesopt)
Constructs a new Execution.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
google.cloud.notebooks.v1.IExecution |
<optional> |
Properties to set |
- Implements:
-
- IExecution
Members
createTime
Execution createTime.
description
Execution description.
displayName
Execution displayName.
executionTemplate
Execution executionTemplate.
jobUri
Execution jobUri.
name
Execution name.
outputNotebookFile
Execution outputNotebookFile.
state
Execution state.
updateTime
Execution updateTime.
State
State enum.
Properties:
Name | Type | Description |
---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
QUEUED |
number |
QUEUED value |
PREPARING |
number |
PREPARING value |
RUNNING |
number |
RUNNING value |
SUCCEEDED |
number |
SUCCEEDED value |
FAILED |
number |
FAILED value |
CANCELLING |
number |
CANCELLING value |
CANCELLED |
number |
CANCELLED value |
EXPIRED |
number |
EXPIRED value |
INITIALIZING |
number |
INITIALIZING value |
Methods
toJSON() → {Object.<string, *>}
Converts this Execution to JSON.
Returns:
Type | Description |
---|---|
Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.notebooks.v1.Execution}
Creates a new Execution instance using the specified properties.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
google.cloud.notebooks.v1.IExecution |
<optional> |
Properties to set |
Returns:
Type | Description |
---|---|
google.cloud.notebooks.v1.Execution |
Execution instance |
(static) decode(reader, lengthopt) → {google.cloud.notebooks.v1.Execution}
Decodes an Execution 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.notebooks.v1.Execution |
Execution |
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.notebooks.v1.Execution}
Decodes an Execution 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.notebooks.v1.Execution |
Execution |
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 Execution message. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
google.cloud.notebooks.v1.IExecution |
Execution 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 Execution message, length delimited. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
google.cloud.notebooks.v1.IExecution |
Execution 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.notebooks.v1.Execution}
Creates an Execution 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.notebooks.v1.Execution |
Execution |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Execution
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 an Execution message. Also converts values to other types if specified.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
google.cloud.notebooks.v1.Execution |
Execution |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
Type | Description |
---|---|
Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies an Execution message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
Type | Description |
---|---|
string | null |
|