Represents a RecurringSchedule.
Package
@google-cloud/os-configConstructors
(constructor)(properties)
constructor(properties?: google.cloud.osconfig.v1beta.IRecurringSchedule);Constructs a new RecurringSchedule.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRecurringSchedule
Properties to set |
Properties
endTime
public endTime?: (google.protobuf.ITimestamp|null);RecurringSchedule endTime.
frequency
public frequency: (google.cloud.osconfig.v1beta.RecurringSchedule.Frequency|keyof typeof google.cloud.osconfig.v1beta.RecurringSchedule.Frequency);RecurringSchedule frequency.
lastExecuteTime
public lastExecuteTime?: (google.protobuf.ITimestamp|null);RecurringSchedule lastExecuteTime.
monthly
public monthly?: (google.cloud.osconfig.v1beta.IMonthlySchedule|null);RecurringSchedule monthly.
nextExecuteTime
public nextExecuteTime?: (google.protobuf.ITimestamp|null);RecurringSchedule nextExecuteTime.
scheduleConfig
public scheduleConfig?: ("weekly"|"monthly");RecurringSchedule scheduleConfig.
startTime
public startTime?: (google.protobuf.ITimestamp|null);RecurringSchedule startTime.
timeOfDay
public timeOfDay?: (google.type.ITimeOfDay|null);RecurringSchedule timeOfDay.
timeZone
public timeZone?: (google.type.ITimeZone|null);RecurringSchedule timeZone.
weekly
public weekly?: (google.cloud.osconfig.v1beta.IWeeklySchedule|null);RecurringSchedule weekly.
Methods
create(properties)
public static create(properties?: google.cloud.osconfig.v1beta.IRecurringSchedule): google.cloud.osconfig.v1beta.RecurringSchedule;Creates a new RecurringSchedule instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRecurringSchedule
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.osconfig.v1beta.RecurringSchedule | RecurringSchedule instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.osconfig.v1beta.RecurringSchedule;Decodes a RecurringSchedule message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.cloud.osconfig.v1beta.RecurringSchedule | RecurringSchedule |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.osconfig.v1beta.RecurringSchedule;Decodes a RecurringSchedule message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.cloud.osconfig.v1beta.RecurringSchedule | RecurringSchedule |
encode(message, writer)
public static encode(message: google.cloud.osconfig.v1beta.IRecurringSchedule, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RecurringSchedule message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRecurringSchedule
RecurringSchedule message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.osconfig.v1beta.IRecurringSchedule, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RecurringSchedule message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRecurringSchedule
RecurringSchedule message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.osconfig.v1beta.RecurringSchedule;Creates a RecurringSchedule message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
google.cloud.osconfig.v1beta.RecurringSchedule | RecurringSchedule |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for RecurringSchedule
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this RecurringSchedule to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.osconfig.v1beta.RecurringSchedule, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a RecurringSchedule message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.osconfig.v1beta.RecurringSchedule
RecurringSchedule |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a RecurringSchedule message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|