Constructor
new Topic(propertiesopt)
Constructs a new Topic.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.pubsub.v1.ITopic |
<optional> |
Properties to set |
- Implements:
-
- ITopic
Members
ingestionDataSourceSettings
Topic ingestionDataSourceSettings.
kmsKeyName
Topic kmsKeyName.
labels
Topic labels.
messageRetentionDuration
Topic messageRetentionDuration.
messageStoragePolicy
Topic messageStoragePolicy.
name
Topic name.
satisfiesPzs
Topic satisfiesPzs.
schemaSettings
Topic schemaSettings.
state
Topic state.
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
ACTIVE |
number |
ACTIVE value |
INGESTION_RESOURCE_ERROR |
number |
INGESTION_RESOURCE_ERROR value |
Methods
toJSON() → {Object.<string, *>}
Converts this Topic to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.pubsub.v1.Topic}
Creates a new Topic instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.pubsub.v1.ITopic |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.pubsub.v1.Topic |
Topic instance |
(static) decode(reader, lengthopt) → {google.pubsub.v1.Topic}
Decodes a Topic message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.pubsub.v1.Topic |
Topic |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.pubsub.v1.Topic}
Decodes a Topic message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.pubsub.v1.Topic |
Topic |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Topic message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.pubsub.v1.ITopic |
Topic message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Topic message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.pubsub.v1.ITopic |
Topic message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.pubsub.v1.Topic}
Creates a Topic message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.pubsub.v1.Topic |
Topic |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Topic
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Topic message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.pubsub.v1.Topic |
Topic |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Topic message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|