Class protos.google.cloud.channel.v1.Period

Represents a Period.

Package

@google-cloud/channel!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.channel.v1.IPeriod);

Constructs a new Period.

Parameter
TypeNameDescription
IPeriodproperties

Properties to set

Properties

duration

public duration: number;

Period duration.

Property Value
TypeDescription
number

periodType

public periodType: (google.cloud.channel.v1.PeriodType|keyof typeof google.cloud.channel.v1.PeriodType);

Period periodType.

Property Value
TypeDescription
(google.cloud.channel.v1.PeriodType|keyof typeof google.cloud.channel.v1.PeriodType)

Methods

create(properties)

public static create(properties?: google.cloud.channel.v1.IPeriod): google.cloud.channel.v1.Period;

Creates a new Period instance using the specified properties.

Parameter
TypeNameDescription
IPeriodproperties

Properties to set

Returns
TypeDescription
google.cloud.channel.v1.Period

Period instance

decode(reader, length)

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

Decodes a Period message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.channel.v1.Period

Period

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.channel.v1.Period;

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.channel.v1.Period

Period

encode(message, writer)

public static encode(message: google.cloud.channel.v1.IPeriod, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Period message. Does not implicitly messages.

Parameters
TypeNameDescription
IPeriodmessage

Period message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.channel.v1.IPeriod, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
TypeNameDescription
IPeriodmessage

Period message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.channel.v1.Period;

Creates a Period message from a plain object. Also converts values to their respective internal types.

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.cloud.channel.v1.Period

Period

toJSON()

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

Converts this Period to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.cloud.channel.v1.Periodmessage

Period

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Period message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not