Represents a Topic.
Package
@google-cloud/pubsub!Constructors
(constructor)(properties)
constructor
(
properties
?:
google
.
pubsub
.
v1
.
ITopic
);
Constructs a new Topic.
| Name | Description |
| properties | ITopic
Properties to set |
Properties
kmsKeyName
public
kmsKeyName
:
string
;
Topic kmsKeyName.
| Type | Description |
|---|---|
| string |
labels
public
labels
:
{
[
k
:
string
]
:
string
};
Topic labels.
| Type | Description |
|---|---|
| { [k: string]: string } |
messageStoragePolicy
public
messageStoragePolicy
?:
(
google
.
pubsub
.
v1
.
IMessageStoragePolicy
|
null
);
Topic messageStoragePolicy.
| Type | Description |
|---|---|
| ( google.pubsub.v1.IMessageStoragePolicy |null) |
name
public
name
:
string
;
Topic name.
| Type | Description |
|---|---|
| string |
satisfiesPzs
public
satisfiesPzs
:
boolean
;
Topic satisfiesPzs.
| Type | Description |
|---|---|
| boolean |
schemaSettings
public
schemaSettings
?:
(
google
.
pubsub
.
v1
.
ISchemaSettings
|
null
);
Topic schemaSettings.
| Type | Description |
|---|---|
| ( 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.
| Name | Description |
| properties | ITopic
Properties to set |
| Type | Description |
|---|---|
| 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.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| length | number
Message length if known beforehand |
| Type | Description |
|---|---|
| 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.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| Type | Description |
|---|---|
| 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.
| Name | Description |
| message | ITopic
Topic message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| 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.
| Name | Description |
| message | ITopic
Topic message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| 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.
| Name | Description |
| object | { [k: string]: any }
Plain object |
| Type | Description |
|---|---|
| google.pubsub.v1.Topic | Topic |
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this Topic to JSON.
| 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.
| Name | Description |
| message | google.pubsub.v1.Topic
Topic |
| options | $protobuf. IConversionOptions
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public
static
verify
(
message
:
{
[
k
:
string
]
:
any
})
:
(
string
|
null
);
Verifies a Topic message.
| Name | Description |
| message | { [k: string]: any }
Plain object to verify |
| Type | Description |
| (string|null) | |
