Represents a Topic.
Package
@google-cloud/pubsubConstructors
(constructor)(properties)
constructor(properties?: google.pubsub.v1.ITopic);Constructs a new Topic.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITopic
Properties to set |
Properties
kmsKeyName
public kmsKeyName: string;Topic kmsKeyName.
labels
public labels: { [k: string]: string };Topic labels.
messageRetentionDuration
public messageRetentionDuration?: (google.protobuf.IDuration|null);Topic messageRetentionDuration.
messageStoragePolicy
public messageStoragePolicy?: (google.pubsub.v1.IMessageStoragePolicy|null);Topic messageStoragePolicy.
name
public name: string;Topic name.
satisfiesPzs
public satisfiesPzs: boolean;Topic satisfiesPzs.
schemaSettings
public schemaSettings?: (google.pubsub.v1.ISchemaSettings|null);Topic schemaSettings.
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 | |
|---|---|
| Name | Description |
properties |
ITopic
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message |
ITopic
Topic 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.ITopic, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Topic message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITopic
Topic 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.Topic;Creates a Topic 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 |
Topic | Topic |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Topic
| 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 Topic to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [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 | |
|---|---|
| Name | Description |
message |
Topic
Topic |
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 Topic message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|