Method: projects.topics.create

HTTP request
Path parameters
Request body
- JSON representation
Response body
Authorization scopes
Try it!

Creates the given topic with the given name. See the resource name rules.

HTTP request

Choose a location:

Path parameters

Parameters

Parameters
`name`	`string` Required. Name of the topic. Format is `projects/{project}/topics/{topic}`.

name

string

Required. Name of the topic. Format is projects/{project}/topics/{topic}.

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "labels": { string: string, ... }, "messageStoragePolicy": { object (`MessageStoragePolicy` ) }, "kmsKeyName": string, "schemaSettings": { object (`SchemaSettings` ) }, "satisfiesPzs": boolean, "messageRetentionDuration": string, "state": enum (`State` ), "ingestionDataSourceSettings": { object (`IngestionDataSourceSettings` ) }, "messageTransforms": [ { object (`MessageTransform` ) } ] }

{
 "labels": {
 string: string,
 ...
 },
 "messageStoragePolicy": {
 object (MessageStoragePolicy )
 },
 "kmsKeyName": string,
 "schemaSettings": {
 object (SchemaSettings )
 },
 "satisfiesPzs": boolean,
 "messageRetentionDuration": string,
 "state": enum (State ),
 "ingestionDataSourceSettings": {
 object (IngestionDataSourceSettings )
 },
 "messageTransforms": [
 {
 object (MessageTransform )
 }
 ]
}

Fields
`labels`	`map (key: string, value: string)` Optional. See Creating and managing labels. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`messageStoragePolicy`	`object (MessageStoragePolicy )` Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
`kmsKeyName`	`string` Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects//locations//keyRings//cryptoKeys/`.
`schemaSettings`	`object (SchemaSettings )` Optional. Settings for validating messages published against a schema.
`satisfiesPzs`	`boolean` Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
`messageRetentionDuration`	`string (Duration format)` Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last `messageRetentionDuration` are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to `messageRetentionDuration` in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `"3.5s"`.
`state`	`enum (State )` Output only. An output-only field indicating the state of the topic.
`ingestionDataSourceSettings`	`object (IngestionDataSourceSettings )` Optional. Settings for ingestion from a data source into this topic.
`messageTransforms[]`	`object (MessageTransform )` Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.

Response body

If successful, the response body contains a newly created instance of Topic .

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Method: projects.topics.create Stay organized with collections Save and categorize content based on your preferences.