Class protos.google.type.DateTime (8.12.0)

Represents a DateTime.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

constructor(properties?: google.type.IDateTime);

Constructs a new DateTime.

Parameter
Name Description
properties IDateTime

Properties to set

Properties

day

public day: number;

DateTime day.

hours

public hours: number;

DateTime hours.

minutes

public minutes: number;

DateTime minutes.

month

public month: number;

DateTime month.

nanos

public nanos: number;

DateTime nanos.

seconds

public seconds: number;

DateTime seconds.

timeOffset

public timeOffset?: ("utcOffset"|"timeZone");

DateTime timeOffset.

timeZone

public timeZone?: (google.type.ITimeZone|null);

DateTime timeZone.

utcOffset

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

DateTime utcOffset.

year

public year: number;

DateTime year.

Methods

create(properties)

public static create(properties?: google.type.IDateTime): google.type.DateTime;

Creates a new DateTime instance using the specified properties.

Parameter
Name Description
properties IDateTime

Properties to set

Returns
Type Description
DateTime

DateTime instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.type.DateTime;

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

DateTime

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.type.DateTime;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DateTime

DateTime

encode(message, writer)

public static encode(message: google.type.IDateTime, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DateTime message. Does not implicitly messages.

Parameters
Name Description
message IDateTime

DateTime 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.type.IDateTime, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IDateTime

DateTime 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.type.DateTime;

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

DateTime

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DateTime

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

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

JSON object

toObject(message, options)

public static toObject(message: google.type.DateTime, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message DateTime

DateTime

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