Class protos.google.pubsub.v1.Snapshot (4.4.0)

Represents a Snapshot.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.pubsub.v1.ISnapshot);

Constructs a new Snapshot.

Parameter
Name	Description
`properties`	`ISnapshot` Properties to set

Properties

expireTime

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

Snapshot expireTime.

labels

public labels: { [k: string]: string };

Snapshot labels.

name

public name: string;

Snapshot name.

topic

public topic: string;

Snapshot topic.

Methods

create(properties)

public static create(properties?: google.pubsub.v1.ISnapshot): google.pubsub.v1.Snapshot;

Creates a new Snapshot instance using the specified properties.

Parameter
Name	Description
`properties`	`ISnapshot` Properties to set

Returns
Type	Description
`Snapshot`	Snapshot instance

decode(reader, length)

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

Decodes a Snapshot 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
`Snapshot`	Snapshot

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.Snapshot;

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`Snapshot`	Snapshot

encode(message, writer)

public static encode(message: google.pubsub.v1.ISnapshot, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Snapshot message. Does not implicitly messages.

Parameters
Name	Description
`message`	`ISnapshot` Snapshot 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.pubsub.v1.ISnapshot, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`ISnapshot` Snapshot 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.pubsub.v1.Snapshot;

Creates a Snapshot 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
`Snapshot`	Snapshot

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Snapshot

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

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`Snapshot` Snapshot
`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 Snapshot 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