Class protos.google.pubsub.v1.Topic

Represents a Topic.

Package

@google-cloud/pubsub!

Constructors

(constructor)(properties)

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

Constructs a new Topic.

Parameter
NameDescription
properties google.pubsub.v1.ITopic

Properties to set

Properties

kmsKeyName

public kmsKeyName: string;

Topic kmsKeyName.

Property Value
TypeDescription
string

labels

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

Topic labels.

Property Value
TypeDescription
{ [k: string]: string }

messageRetentionDuration

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

Topic messageRetentionDuration.

Property Value
TypeDescription
(google.protobuf.IDuration|null)

messageStoragePolicy

public messageStoragePolicy?: (google.pubsub.v1.IMessageStoragePolicy|null);

Topic messageStoragePolicy.

Property Value
TypeDescription
(google.pubsub.v1.IMessageStoragePolicy|null)

name

public name: string;

Topic name.

Property Value
TypeDescription
string

satisfiesPzs

public satisfiesPzs: boolean;

Topic satisfiesPzs.

Property Value
TypeDescription
boolean

schemaSettings

public schemaSettings?: (google.pubsub.v1.ISchemaSettings|null);

Topic schemaSettings.

Property Value
TypeDescription
(google.pubsub.v1.ISchemaSettings|null)

Methods

create(properties)

public static create(properties?: google.pubsub.v1.ITopic): google.pubsub.v1.Topic;

Creates a new Topic instance using the specified properties.

Parameter
NameDescription
properties google.pubsub.v1.ITopic

Properties to set

Returns
TypeDescription
google.pubsub.v1.Topic

Topic instance

decode(reader, length)

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

Decodes a Topic 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.pubsub.v1.Topic

Topic

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.pubsub.v1.Topic

Topic

encode(message, writer)

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

Encodes the specified Topic message. Does not implicitly messages.

Parameters
NameDescription
message google.pubsub.v1.ITopic

Topic 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.pubsub.v1.ITopic, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message google.pubsub.v1.ITopic

Topic 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.pubsub.v1.Topic;

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

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

Plain object

Returns
TypeDescription
google.pubsub.v1.Topic

Topic

toJSON()

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

Converts this Topic to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.pubsub.v1.Topic

Topic

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