Class protos.google.spanner.admin.database.v1.CrontabSpec (0.2.0)

Represents a CrontabSpec.

Implements

Package

@google-cloud/spanner-api

Constructors

(constructor)(properties)

constructor(properties?: google.spanner.admin.database.v1.ICrontabSpec);

Constructs a new CrontabSpec.

Parameter
Name Description
properties ICrontabSpec

Properties to set

Properties

creationWindow

public creationWindow?: (google.protobuf.IDuration|null);

CrontabSpec creationWindow.

text

public text: string;

CrontabSpec text.

timeZone

public timeZone: string;

CrontabSpec timeZone.

Methods

create(properties)

public static create(properties?: google.spanner.admin.database.v1.ICrontabSpec): google.spanner.admin.database.v1.CrontabSpec;

Creates a new CrontabSpec instance using the specified properties.

Parameter
Name Description
properties ICrontabSpec

Properties to set

Returns
Type Description
CrontabSpec

CrontabSpec instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.spanner.admin.database.v1.CrontabSpec;

Decodes a CrontabSpec 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
CrontabSpec

CrontabSpec

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.spanner.admin.database.v1.CrontabSpec;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CrontabSpec

CrontabSpec

encode(message, writer)

public static encode(message: google.spanner.admin.database.v1.ICrontabSpec, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CrontabSpec message. Does not implicitly messages.

Parameters
Name Description
message ICrontabSpec

CrontabSpec 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.spanner.admin.database.v1.ICrontabSpec, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICrontabSpec

CrontabSpec 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.spanner.admin.database.v1.CrontabSpec;

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

CrontabSpec

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CrontabSpec

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

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

JSON object

toObject(message, options)

public static toObject(message: google.spanner.admin.database.v1.CrontabSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message CrontabSpec

CrontabSpec

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