Creates a subscription to a given topic. See the resource name rules
. If the
subscription already exists, returns ALREADY_EXISTS
. If the
corresponding topic doesn't exist, returns NOT_FOUND
. If the name is
not provided in the request, the server will assign a random name for
this subscription on the same project as the topic, conforming to the resource name format
. The
generated name is populated in the returned Subscription object. Note
that for REST API requests, you must specify a name in the request.
Arguments
name
string
Required. The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}"
. {subscription}
must start with a letter, and contain only letters ( [A-Za-z]
), numbers ( [0-9]
), dashes ( -
), underscores ( _
), periods ( .
), tildes ( ~
), plus ( +
) or percent signs ( %
). It must be between 3 and 255 characters in length, and it must not start with "goog"
.
body
object ( Subscription
)
Required.
Raised exceptions
ConnectionError
HttpError
TimeoutError
TypeError
ValueError
Response
If successful, the response contains an instance of Subscription
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation .
YAML
- create : call : googleapis.pubsub.v1.projects.subscriptions.create args : name : ... body : ackDeadlineSeconds : ... deadLetterPolicy : deadLetterTopic : ... maxDeliveryAttempts : ... detached : ... enableMessageOrdering : ... expirationPolicy : ttl : ... filter : ... labels : ... messageRetentionDuration : ... name : ... pushConfig : attributes : ... oidcToken : audience : ... serviceAccountEmail : ... pushEndpoint : ... retainAckedMessages : ... retryPolicy : maximumBackoff : ... minimumBackoff : ... topic : ... result : createResult
JSON
[ { "create" : { "call" : "googleapis.pubsub.v1.projects.subscriptions.create" , "args" : { "name" : "..." , "body" : { "ackDeadlineSeconds" : "..." , "deadLetterPolicy" : { "deadLetterTopic" : "..." , "maxDeliveryAttempts" : "..." }, "detached" : "..." , "enableMessageOrdering" : "..." , "expirationPolicy" : { "ttl" : "..." }, "filter" : "..." , "labels" : "..." , "messageRetentionDuration" : "..." , "name" : "..." , "pushConfig" : { "attributes" : "..." , "oidcToken" : { "audience" : "..." , "serviceAccountEmail" : "..." }, "pushEndpoint" : "..." }, "retainAckedMessages" : "..." , "retryPolicy" : { "maximumBackoff" : "..." , "minimumBackoff" : "..." }, "topic" : "..." } }, "result" : "createResult" } } ]
