Class protos.google.cloud.bigquery.datatransfer.v1.ScheduleOptions (2.3.0)

Represents a ScheduleOptions.

Package

@google-cloud/bigquery-data-transfer

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.datatransfer.v1.IScheduleOptions);

Constructs a new ScheduleOptions.

Parameter
NameDescription
properties IScheduleOptions

Properties to set

Properties

disableAutoScheduling

public disableAutoScheduling: boolean;

ScheduleOptions disableAutoScheduling.

endTime

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

ScheduleOptions endTime.

startTime

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

ScheduleOptions startTime.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.datatransfer.v1.IScheduleOptions): google.cloud.bigquery.datatransfer.v1.ScheduleOptions;

Creates a new ScheduleOptions instance using the specified properties.

Parameter
NameDescription
properties IScheduleOptions

Properties to set

Returns
TypeDescription
google.cloud.bigquery.datatransfer.v1.ScheduleOptions

ScheduleOptions instance

decode(reader, length)

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

Decodes a ScheduleOptions 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.bigquery.datatransfer.v1.ScheduleOptions

ScheduleOptions

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.datatransfer.v1.ScheduleOptions;

Decodes a ScheduleOptions 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.bigquery.datatransfer.v1.ScheduleOptions

ScheduleOptions

encode(message, writer)

public static encode(message: google.cloud.bigquery.datatransfer.v1.IScheduleOptions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ScheduleOptions message. Does not implicitly messages.

Parameters
NameDescription
message IScheduleOptions

ScheduleOptions 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.bigquery.datatransfer.v1.IScheduleOptions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IScheduleOptions

ScheduleOptions 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.bigquery.datatransfer.v1.ScheduleOptions;

Creates a ScheduleOptions 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.bigquery.datatransfer.v1.ScheduleOptions

ScheduleOptions

toJSON()

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

Converts this ScheduleOptions to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.bigquery.datatransfer.v1.ScheduleOptions

ScheduleOptions

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 ScheduleOptions 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