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