Class protos.google.cloud.sql.v1.SqlInstancesRescheduleMaintenanceRequestBody.Reschedule (0.16.0)

Represents a Reschedule.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.sql.v1.SqlInstancesRescheduleMaintenanceRequestBody.IReschedule);

Constructs a new Reschedule.

Parameter
Name Description
properties IReschedule

Properties to set

Properties

rescheduleType

public rescheduleType: (google.cloud.sql.v1.SqlInstancesRescheduleMaintenanceRequestBody.RescheduleType|keyof typeof google.cloud.sql.v1.SqlInstancesRescheduleMaintenanceRequestBody.RescheduleType);

Reschedule rescheduleType.

scheduleTime

public scheduleTime?: (google.protobuf.ITimestamp|null);

Reschedule scheduleTime.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1.SqlInstancesRescheduleMaintenanceRequestBody.IReschedule): google.cloud.sql.v1.SqlInstancesRescheduleMaintenanceRequestBody.Reschedule;

Creates a new Reschedule instance using the specified properties.

Parameter
Name Description
properties IReschedule

Properties to set

Returns
Type Description
Reschedule

Reschedule instance

decode(reader, length)

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

Decodes a Reschedule message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
Reschedule

Reschedule

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.sql.v1.SqlInstancesRescheduleMaintenanceRequestBody.Reschedule;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Reschedule

Reschedule

encode(message, writer)

public static encode(message: google.cloud.sql.v1.SqlInstancesRescheduleMaintenanceRequestBody.IReschedule, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Reschedule message. Does not implicitly messages.

Parameters
Name Description
message IReschedule

Reschedule 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.sql.v1.SqlInstancesRescheduleMaintenanceRequestBody.IReschedule, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IReschedule

Reschedule 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.sql.v1.SqlInstancesRescheduleMaintenanceRequestBody.Reschedule;

Creates a Reschedule 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
Reschedule

Reschedule

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Reschedule

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 Reschedule to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Reschedule

Reschedule

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 Reschedule message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not