RecurringSchedule

google.cloud.osconfig.v1. RecurringSchedule

Represents a RecurringSchedule.

Constructor

new RecurringSchedule(propertiesopt)

Constructs a new RecurringSchedule.

Parameters:
Name Type Attributes Description
properties google.cloud.osconfig.v1.IRecurringSchedule <optional>

Properties to set

Implements:
  • IRecurringSchedule

Members

endTime

RecurringSchedule endTime.

frequency

RecurringSchedule frequency.

lastExecuteTime

RecurringSchedule lastExecuteTime.

monthly

RecurringSchedule monthly.

nextExecuteTime

RecurringSchedule nextExecuteTime.

scheduleConfig

RecurringSchedule scheduleConfig.

startTime

RecurringSchedule startTime.

timeOfDay

RecurringSchedule timeOfDay.

timeZone

RecurringSchedule timeZone.

weekly

RecurringSchedule weekly.

Frequency

Frequency enum.

Properties:
Name Type Description
FREQUENCY_UNSPECIFIED number

FREQUENCY_UNSPECIFIED value

WEEKLY number

WEEKLY value

MONTHLY number

MONTHLY value

DAILY number

DAILY value

Methods

toJSON() → {Object.<string, *>}

Converts this RecurringSchedule to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.osconfig.v1.RecurringSchedule}

Creates a new RecurringSchedule instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.osconfig.v1.IRecurringSchedule <optional>

Properties to set

Returns:
Type Description
google.cloud.osconfig.v1.RecurringSchedule

RecurringSchedule instance

(static) decode(reader, lengthopt) → {google.cloud.osconfig.v1.RecurringSchedule}

Decodes a RecurringSchedule 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.osconfig.v1.RecurringSchedule

RecurringSchedule

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.osconfig.v1.RecurringSchedule}

Decodes a RecurringSchedule 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.osconfig.v1.RecurringSchedule

RecurringSchedule

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 RecurringSchedule message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.osconfig.v1.IRecurringSchedule

RecurringSchedule 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 RecurringSchedule message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.osconfig.v1.IRecurringSchedule

RecurringSchedule 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.osconfig.v1.RecurringSchedule}

Creates a RecurringSchedule 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.osconfig.v1.RecurringSchedule

RecurringSchedule

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for RecurringSchedule

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 RecurringSchedule message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.osconfig.v1.RecurringSchedule

RecurringSchedule

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a RecurringSchedule message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not