delete_topic¶
Operation¶
delete_topic
¶
delete_topic(request: DeleteTopicInput | DeleteTopicInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteTopicInputDict]) -> DeleteTopicOutput
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteTopicInput | DeleteTopicInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DeleteTopicInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteTopicOutput
|
An instance of |
delete_topic
async
¶
delete_topic(request: DeleteTopicInput | DeleteTopicInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteTopicInputDict]) -> DeleteTopicOutput
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteTopicInput | DeleteTopicInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DeleteTopicInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteTopicOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
DeleteTopicOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteTopicOutput structure.