| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="pubsub_v1beta2.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1beta2.projects.html">projects</a> . <a href="pubsub_v1beta2.projects.topics.html">topics</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="pubsub_v1beta2.projects.topics.subscriptions.html">subscriptions()</a></code> |
| </p> |
| <p class="firstline">Returns the subscriptions Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#create">create(name, body)</a></code></p> |
| <p class="firstline">Creates the given topic with the given name.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(topic)</a></code></p> |
| <p class="firstline">Deletes the topic with the given name. All subscriptions to this topic are detached from the topic. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(topic)</a></code></p> |
| <p class="firstline">Gets the configuration of a topic.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(project, pageSize=None, pageToken=None)</a></code></p> |
| <p class="firstline">Lists matching topics.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#publish">publish(topic, body)</a></code></p> |
| <p class="firstline">Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(name, body)</code> |
| <pre>Creates the given topic with the given name. |
| |
| Args: |
| name: string, A parameter (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { |
| "name": "A String", |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "name": "A String", |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(topic)</code> |
| <pre>Deletes the topic with the given name. All subscriptions to this topic are detached from the topic. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. |
| |
| Args: |
| topic: string, A parameter (required) |
| |
| Returns: |
| An object of the form: |
| |
| { |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(topic)</code> |
| <pre>Gets the configuration of a topic. |
| |
| Args: |
| topic: string, A parameter (required) |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "name": "A String", |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(project, pageSize=None, pageToken=None)</code> |
| <pre>Lists matching topics. |
| |
| Args: |
| project: string, A parameter (required) |
| pageSize: integer, A parameter |
| pageToken: string, A parameter |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "nextPageToken": "A String", |
| "topics": [ |
| { |
| "name": "A String", |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="publish">publish(topic, body)</code> |
| <pre>Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. |
| |
| Args: |
| topic: string, A parameter (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { |
| "messages": [ |
| { |
| "attributes": { |
| "a_key": "A String", |
| }, |
| "data": "A String", |
| "messageId": "A String", |
| }, |
| ], |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "messageIds": [ |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |