Class protos.google.cloud.osconfig.v1.MonthlySchedule

Represents a MonthlySchedule.

Package

@google-cloud/os-config

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.osconfig.v1.IMonthlySchedule);

Constructs a new MonthlySchedule.

Parameter
NameDescription
properties IMonthlySchedule

Properties to set

Properties

dayOfMonth

public dayOfMonth?: ("weekDayOfMonth"|"monthDay");

MonthlySchedule dayOfMonth.

monthDay

public monthDay?: (number|null);

MonthlySchedule monthDay.

weekDayOfMonth

public weekDayOfMonth?: (google.cloud.osconfig.v1.IWeekDayOfMonth|null);

MonthlySchedule weekDayOfMonth.

Methods

create(properties)

public static create(properties?: google.cloud.osconfig.v1.IMonthlySchedule): google.cloud.osconfig.v1.MonthlySchedule;

Creates a new MonthlySchedule instance using the specified properties.

Parameter
NameDescription
properties IMonthlySchedule

Properties to set

Returns
TypeDescription
google.cloud.osconfig.v1.MonthlySchedule

MonthlySchedule instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.osconfig.v1.MonthlySchedule;

Decodes a MonthlySchedule message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.osconfig.v1.MonthlySchedule

MonthlySchedule

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.osconfig.v1.MonthlySchedule;

Decodes a MonthlySchedule message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.osconfig.v1.MonthlySchedule

MonthlySchedule

encode(message, writer)

public static encode(message: google.cloud.osconfig.v1.IMonthlySchedule, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MonthlySchedule message. Does not implicitly messages.

Parameters
NameDescription
message IMonthlySchedule

MonthlySchedule message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.osconfig.v1.IMonthlySchedule, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MonthlySchedule message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IMonthlySchedule

MonthlySchedule message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.osconfig.v1.MonthlySchedule;

Creates a MonthlySchedule message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.osconfig.v1.MonthlySchedule

MonthlySchedule

toJSON()

public toJSON(): { [k: string]: any };

Converts this MonthlySchedule to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.osconfig.v1.MonthlySchedule, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a MonthlySchedule message. Also converts values to other types if specified.

Parameters
NameDescription
message google.cloud.osconfig.v1.MonthlySchedule

MonthlySchedule

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a MonthlySchedule message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not